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

Fix capitalization errors in playbook navigation #983

Merged
merged 2 commits into from
Aug 15, 2023

Conversation

day-jeff
Copy link
Contributor

What are you trying to address

  • Mkdocs uses the page title for the navigation label, but it can't do that for folders that don't have README.md files. In these cases, it removes dashes and underscores from folder names and applies sentence-case capitalization. This is always incorrect if the folder name uses acronyms or mixed case words.
  • The result is that the EF playbook has incorrect nav labels in many spots. For example, CI/CD spelled Ci/cd or GitOps as Gitops.
  • Goal is to fix capitalization errors in the mkdocs nav

Detailed description of all changes

  • Add awesome pages plugin, which we use in the Solutions Playbook. Powerful, reliable, and widely used
  • Create .pages files in folders where there are obvious capitalization errors in the nav.
  • Note: I did not change capitalization inconsistencies that are common in the playbook. For example, most nav items use the mkdocs default sentence-casing (Only the first word is caps), but some devs have used caps in folder names resulting in partiall proper casing (All Words Are Caps).

…ors in the mkdocs nav (primarily acronyms being shown in lower case)
@day-jeff day-jeff added the bug Something isn't working label Jul 27, 2023
@github-actions
Copy link

github-actions bot commented Jul 27, 2023

🦙 MegaLinter status: ⚠️ WARNING

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.06s
⚠️ MARKDOWN markdownlint 244 1 6.51s
⚠️ MARKDOWN markdown-table-formatter 244 1 0.51s
✅ MDLINKCHECK linkcheck 244 0 17.61s
✅ SPELL cspell 255 0 14.15s
✅ YAML prettier 10 0 0.78s
✅ YAML yamllint 10 0 0.43s

See detailed report in MegaLinter reports

You could have same capabilities but better runtime performances if you request a new MegaLinter flavor.

MegaLinter is graciously provided by OX Security

@TessFerrandez TessFerrandez merged commit 58a00e2 into main Aug 15, 2023
2 checks passed
@TessFerrandez TessFerrandez deleted the jeffday/nav-cleanup branch August 15, 2023 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants