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

Rename markdown files to match current chapter and section names #263

Merged
merged 12 commits into from
Jun 30, 2023

Conversation

ahouseholder
Copy link
Contributor

Fixes #254

  • For short chapters, use CC_name.md
  • When chapters are too big for one file an need to be split up, use CC_SS_name.md

Where

  • CC = zero-padded chapter number
  • SS = zero-padded section number (chapter intro SS should be 00)
  • name = a string derived from the first heading in the file

Also modify the Makefile

  • generate non-versioned filenames
  • use current commit hash as fix version
    • yes, this violates strict incremntal SemVer, but I think this is ok because the makefile is only producing a review draft anyway

Finally

  • Fix the second Acknowledgements section which was really a copyright notice
  • Bump the copyright year to 2023

@ahouseholder ahouseholder added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 30, 2023
@ahouseholder ahouseholder added this to the SSVC v2.1 milestone Jun 30, 2023
@ahouseholder ahouseholder requested review from j--- and cgyarbrough June 30, 2023 19:01
@ahouseholder ahouseholder self-assigned this Jun 30, 2023
@j--- j--- merged commit a868337 into main Jun 30, 2023
@ahouseholder ahouseholder deleted the feature/fix_254 branch June 30, 2023 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Markdown file names should more closely follow document section names
2 participants