Skip to content
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

Convert RTC product guide to markdown #11

Merged
merged 19 commits into from
Mar 24, 2021
Merged

Convert RTC product guide to markdown #11

merged 19 commits into from
Mar 24, 2021

Conversation

asjohnston-asf
Copy link
Member

@asjohnston-asf asjohnston-asf commented Oct 16, 2020

Still a ways off, but wanted to at least but the draft in front of people and see if we like the styling.

  • images are missing
  • I took out the section numbers but I'm considering adding them back in Question posed in Should we include section numbers in the RTC product guide? #60
  • I took out the abbreviations section but I'm considering putting it back (maybe on a separate page) Opened issue Include a glossary #59 to do this later
  • I took out the change control page, I assume we'll let github handle that
  • mkdocs only provides anchors and TOC entries for H2 and H3 headers, not H4, so there's a link to Quantifying Change over Time that's broken at the moment
  • still need to fix the production document having two Figure 5s
  • citations aren't quite formatted correctly (needs to indent on word-wrap) Opened issue Need better reference/citation formatting #61 to track

Also updated some out-of-date content: Opened #62 to track

  • README.txt is now README.md.txt
  • iso.xml is removed

@jhkennedy
Copy link
Contributor

Our current mkdocs + material theme can handle a central glossary and hover over definitions of terms in the glossary:

https://squidfunk.github.io/mkdocs-material/reference/abbreviations/

@jhkennedy
Copy link
Contributor

citations aren't quite formatted correctly (needs to indent on word-wrap)

It might be worth using mkdocs-bibtex to support citation management

@jhkennedy jhkennedy changed the base branch from main to develop March 24, 2021 18:34
@jhkennedy jhkennedy requested a review from a team March 24, 2021 18:34
@jhkennedy jhkennedy added the bumpless Changes to documentation, CI/CD pipelines, etc that don't affect the project's version label Mar 24, 2021
@jhkennedy jhkennedy removed the bumpless Changes to documentation, CI/CD pipelines, etc that don't affect the project's version label Mar 24, 2021
@jhkennedy jhkennedy marked this pull request as ready for review March 24, 2021 18:38
@jhkennedy jhkennedy merged commit dfab279 into develop Mar 24, 2021
@jhkennedy jhkennedy deleted the product-guide branch March 24, 2021 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants