Skip to content

Replace typographic quotes with straight ASCII#1004

Merged
berendt merged 3 commits into
mainfrom
fix-typographic-quotes
Jun 23, 2026
Merged

Replace typographic quotes with straight ASCII#1004
berendt merged 3 commits into
mainfrom
fix-typographic-quotes

Conversation

@ideaship

Copy link
Copy Markdown
Contributor

Replaces typographic (curly) quote characters with straight ASCII equivalents across the built docs, for consistency.

  • One commit per category:
    • config-guide: fix curly quote in rpc_workers YAML — a left double quote (U+201C) had replaced the closing " in a YAML example, making the snippet invalid.
    • ops-guide: use straight quotes around OSD reference — curly single quotes (U+2018/U+2019) around a section reference in the Ceph guide.
    • docs: use straight apostrophes in prose contractions — curly apostrophes (U+2019) in "Kolla's", "Cluster API's", "OpenStack's", "Let's Encrypt", "let's define".

Note: the 'logs in' fix in deploy-guide/manager.md lives on the separate fix-apostrophes branch and is intentionally not duplicated here.

🤖 Generated with Claude Code

ideaship added 3 commits June 22, 2026 10:49
The openstack_service_rpc_workers example in the OpenStack
configuration guide ended with a typographic left double quote
(U+201C) instead of a straight ASCII double quote, making the
YAML snippet invalid as written.

AI-assisted: Claude Code
Signed-off-by: Roger Luethi <luethi@osism.tech>
The Ceph operations guide quoted the 'Remove a single OSD node'
section reference with typographic single quotes (U+2018/U+2019).
Replace them with straight ASCII apostrophes for consistency.

AI-assisted: Claude Code
Signed-off-by: Roger Luethi <luethi@osism.tech>
Several pages used typographic apostrophes (U+2019) in
contractions and possessives ("Kolla's", "Cluster API's",
"OpenStack's", "Let's Encrypt", "let's define"). Replace them
with straight ASCII apostrophes for consistency across the docs.

AI-assisted: Claude Code
Signed-off-by: Roger Luethi <luethi@osism.tech>
@github-actions

github-actions Bot commented Jun 22, 2026

Copy link
Copy Markdown

⚠️MegaLinter analysis: Success with warnings

Descriptor Linter Files Fixed Errors Warnings Elapsed time
✅ ACTION actionlint 4 0 0 0.01s
✅ JSON jsonlint 4 0 0 0.07s
✅ JSON prettier 4 0 0 0.22s
✅ JSON v8r 4 0 0 5.3s
⚠️ MARKDOWN markdownlint 160 4 0 1.37s
⚠️ MARKDOWN markdown-table-formatter 160 1 0 0.27s
✅ REPOSITORY checkov yes no no 14.66s
✅ REPOSITORY git_diff yes no no 0.04s
✅ REPOSITORY secretlint yes no no 0.93s
✅ REPOSITORY trufflehog yes no no 2.44s
✅ SPELL codespell 169 0 0 0.33s
⚠️ SPELL lychee 169 1 0 28.76s
✅ YAML prettier 5 0 0 0.23s
✅ YAML v8r 5 0 0 3.77s
✅ YAML yamllint 5 0 0 0.32s

Detailed Issues

⚠️ SPELL / lychee - 1 error
📝 Summary
---------------------
🔍 Total..........920
🔗 Unique.........744
✅ Successful.....855
⏳ Timeouts.........4
🔀 Redirected......46
👻 Excluded........61
❓ Unknown..........0
🚫 Errors...........0
⛔ Unsupported......0

Errors in docs/guides/deploy-guide/services/openstack.md
[TIMEOUT] https://www.openstack.org/software/project-navigator/openstack-components#openstack-services (at 14:5) | Request timed out

Errors in docs/guides/user-guide/openstack/migration-vmware-esxi.md
[TIMEOUT] https://www.openstack.org/vmware-migration-to-openstack (at 20:1) | Request timed out

Errors in docs/release-notes/osism-7.md
[TIMEOUT] https://www.openstack.org/software/openstack-bobcat (at 977:38) | Request timed out

Errors in docs/release-notes/osism-8.md
[TIMEOUT] https://www.openstack.org/software/openstack-caracal (at 222:38) | Request timed out

Hint: Followed 46 redirects. You might want to consider replacing redirecting URLs with the resolved URLs. Use verbose mode (`-v`/`-vv`) to see redirection details.
⚠️ MARKDOWN / markdown-table-formatter - 1 error
1 files contain markdown tables to format:
- docs/guides/developer-guide/retiring-openstack-releases.md
⚠️ MARKDOWN / markdownlint - 4 errors
docs/guides/developer-guide/retiring-openstack-releases.md:181:450 error MD060/table-column-style Table column style [Table pipe does not align with header for style "aligned"]
docs/guides/developer-guide/retiring-openstack-releases.md:181:535 error MD060/table-column-style Table column style [Table pipe does not align with header for style "aligned"]
docs/guides/developer-guide/retiring-openstack-releases.md:183:417 error MD060/table-column-style Table column style [Table pipe does not align with header for style "aligned"]
docs/guides/developer-guide/retiring-openstack-releases.md:183:502 error MD060/table-column-style Table column style [Table pipe does not align with header for style "aligned"]

Notices

📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)

See detailed reports in MegaLinter artifacts

Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)

  • Documentation: Custom Flavors
  • Command: npx mega-linter-runner@9.5.0 --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,JSON_JSONLINT,JSON_V8R,JSON_PRETTIER,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_CHECKOV,REPOSITORY_GIT_DIFF,REPOSITORY_SECRETLINT,REPOSITORY_TRUFFLEHOG,SPELL_LYCHEE,SPELL_CODESPELL,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R

MegaLinter is graciously provided by OX Security
Show us your support by starring ⭐ the repository

@ideaship ideaship marked this pull request as ready for review June 22, 2026 09:07
@berendt berendt merged commit a5ff6ac into main Jun 23, 2026
5 checks passed
@berendt berendt deleted the fix-typographic-quotes branch June 23, 2026 10:08
@github-project-automation github-project-automation Bot moved this from Ready to Done in Human Board Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants