Skip to content

Fix #679, Add Markdown version of OSAL Configuration Guide#659

Merged
astrogeco merged 1 commit intonasa:integration-candidatefrom
ArielSAdamsNASA:main
Dec 18, 2020
Merged

Fix #679, Add Markdown version of OSAL Configuration Guide#659
astrogeco merged 1 commit intonasa:integration-candidatefrom
ArielSAdamsNASA:main

Conversation

@ArielSAdamsNASA
Copy link
Contributor

@ArielSAdamsNASA ArielSAdamsNASA commented Nov 17, 2020 •
edited by skliper
Loading

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

@ArielSAdamsNASA ArielSAdamsNASA added the CCB:Ignore Incomplete Pull Request with open actions. label Nov 17, 2020
@ArielSAdamsNASA ArielSAdamsNASA requested review from a user and astrogeco November 17, 2020 20:31
@skliper
Copy link
Contributor

skliper commented Dec 9, 2020

@astrogeco @ArielSAdamsNASA - what's the status on this? It would help to move it forward...

@skliper
Copy link
Contributor

skliper commented Dec 9, 2020

Also delete the other versions... markdown only preferred.

@skliper skliper added this to the 6.0.0 milestone Dec 9, 2020
@ArielSAdamsNASA
Copy link
Contributor Author

ArielSAdamsNASA commented Dec 9, 2020

@astrogeco @ArielSAdamsNASA - what's the status on this? It would help to move it forward...

@skliper Waiting on @acudmore for approval/feedback. I sent him an email this morning.

@skliper
Copy link
Contributor

skliper commented Dec 9, 2020

Related to #384, the issue to update the contents. A format check here should be sufficient (and will simplify fixing #384).

astrogeco
astrogeco suggested changes Dec 10, 2020
View reviewed changes
Copy link
Contributor

@astrogeco astrogeco left a 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.

astrogeco
astrogeco suggested changes Dec 10, 2020
View reviewed changes
Copy link
Contributor

@astrogeco astrogeco left a 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.

@ArielSAdamsNASA
Copy link
Contributor Author

ArielSAdamsNASA commented Dec 10, 2020

I removed the pdf and doc versions of the guide and updated the markdown version.

For the markdown version:

  • Removed the front matter, so the Introduction is the first section
  • Updated headers to use the markdown syntax # and removed horizontal rule for headers
  • Updated table headers to use fourth-level headers
  • Use a code block for the section starting with $ sparc-rtems4.10-gdb tasking-example.nxe
  • Moved Revision History to the bottom of the page for now

ghost
ghost reviewed Dec 14, 2020
View reviewed changes
ghost
ghost approved these changes Dec 14, 2020
View reviewed changes
Copy link

@ghost ghost left a 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.

@astrogeco
Copy link
Contributor

astrogeco commented Dec 14, 2020 •
edited
Loading

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

@ArielSAdamsNASA ArielSAdamsNASA changed the title Added Markdown version of OSAL Configuration Guide Fix #679, Add Markdown version of OSAL Configuration Guide Dec 15, 2020
@ArielSAdamsNASA ArielSAdamsNASA marked this pull request as ready for review December 15, 2020 15:30
@ArielSAdamsNASA ArielSAdamsNASA added CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) and removed CCB:Ignore Incomplete Pull Request with open actions. labels Dec 15, 2020
@astrogeco
Copy link
Contributor

astrogeco commented Dec 16, 2020 •
edited
Loading

CCB 2020-12-16 APPROVED

@astrogeco astrogeco added CCB-20201216 and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels Dec 16, 2020
@astrogeco astrogeco changed the base branch from main to integration-candidate December 17, 2020 16:15
@astrogeco astrogeco merged commit 26360b7 into nasa:integration-candidate Dec 18, 2020
astrogeco added a commit to nasa/cFS that referenced this pull request Dec 18, 2020
@astrogeco
Add nasa/osal#682 and nasa/osal#659
6151193
@astrogeco astrogeco mentioned this pull request Dec 18, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@astrogeco astrogeco astrogeco approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

Caelum

Development

Successfully merging this pull request may close these issues.

Convert doc/OSAL-Configuration-guide.doc to markdown

4 participants

@ArielSAdamsNASA @skliper @astrogeco @arielswalker