-
Notifications
You must be signed in to change notification settings - Fork 215
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix #679, Add Markdown version of OSAL Configuration Guide #659
Conversation
@astrogeco @ArielSAdamsNASA - what's the status on this? It would help to move it forward... |
Also delete the other versions... markdown only preferred. |
@skliper Waiting on @acudmore for approval/feedback. I sent him an email this morning. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mainly format cleanups. It might be worthwhile to do a find-and-replace on bold and italic syntax "***" which is sometimes used for subheadings in this document. Similarly horizontal rules "===" are also being used in a subheading fashion.
It might be worth passing this through a markdown linter like remark or prettier; there are Atom and VSCode plugins for to help with that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove "markdown" from the file name and use git rm
to remove the pdf and doc versions of the guide.
I removed the pdf and doc versions of the guide and updated the markdown version. For the markdown version:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The conversion is good, there are a couple of table format issues ( in the glossary for example ). But this conversion and removing the old documents is the first step, I think the doc needs to be overhauled in content after this conversion. Much of the technical info is out of date.
Looks good! I would do an interactive rebase and squash the table fix into the original md commit. Also edit the commit message to use the format "Fix #XYZ, COMMIT_DESCRIPTION". Once ready click "ready for review" to remove the PR's draft status. Finally add the CCB-READY label |
CCB 2020-12-16 APPROVED
|
Fix #697, Fix formatting
Describe the contribution
Pandoc was used to convert the OSAL Configuration Guide to a markdown file. During the conversion, issues were presented such as broken tables. Tables were fixed and block codes were added where appropriate.
Fix #679
Additional context
Please provide feedback on whether the markdown file is acceptable in terms of formatting.
Contributor Info - All information REQUIRED for consideration of pull request
Ariel Adams, ASRC Federal