Fix spelling, broken links, and navigation issues #666
Conversation
| "https://dev.mysql.com/*", | ||
| "https://www.mysql.com/*" |
There was a problem hiding this comment.
Ignoring these mysql.com domains because they seem to have protections against the User-Agent headings sent by the GitHub CI, so they return a 403. (At least that's my theory, since running the linkcheck locally and doing a curl request both work fine)
Unsure if there's a better way of handling this so that we can still check for the validity of mysql.com links, like overriding the header with a known user agent.
There was a problem hiding this comment.
Thanks again for the big effort. If this is the right PR to address spelling / links / navigation issues, let me remind you about formatting that is not rendered correctly:
- Explicit
[u]...[/u]across many pages. - Explicit
:information_source:across many pages.
|
@sinclert-canonical This PR was mainly to fix things that would break the docs checks in the CI, and making sure the navigation works. That being said, those are two pretty self-contained fixes so I think it's worth adding to the PR - thank you for the reminder! There's a huge amount of formatting and style issues left to address, so that'll come soon now that the Sphinx build and CI are both stable. |
Co-authored-by: Paulo Machado <[email protected]>
* Integrate documentation starter pack into repository (#662) * add starter pack and raw markdown docs * add CI doc checks * clean up rogue files and add closing toctree backticks * fix H1 headings, end delimiters, and how-to/ references * fix sphinx build errors * update essential conf.py parameters * remove ci checks to avoid unnecessary runner use * fix typo * change main branch for rtd builds * remove sync_docs workflow and ignore docs folder in CI checks * fix toctrees and landing pages * fix spelling and link errors * add doc ci workflow * remove update script * Add mysql.com domains to linkcheck ignore * generalize azure portal url to ignore in linkcheck * remove emojis and discourse underline notation * refactor tutorial (wip) * update contacts page * polish tutorial * add manage-passwords guide * Fix spelling, broken links, and navigation issues (#666) * fix toctrees and landing pages * fix spelling and link errors * add doc ci workflow * remove update script * Add mysql.com domains to linkcheck ignore * generalize azure portal url to ignore in linkcheck * remove emojis and discourse underline notation * update contacts page * Update docs/how-to/development/migrate-data-via-backup-restore.md Co-authored-by: Paulo Machado <[email protected]> * update legacy charm warning --------- Co-authored-by: Paulo Machado <[email protected]> * Fix old tutorial references and remove rogue PostgreSQL mentions * polish and sync with K8s * finish polishing and syncing with K8s * fix broken reference * update branch for readthedocs.yaml build check * fix broken links * fix broken link * docs: [DPE-7404] Promote-to-primary docs (#675) * promote-to-primary docs * rename and text fixes * typo fix * Update docs/index.md Co-authored-by: Vladimir Izmalkov <[email protected]> * Update docs/index.md Co-authored-by: Vladimir Izmalkov <[email protected]> * apply review comments --------- Co-authored-by: Paulo Machado <[email protected]> Co-authored-by: Vladimir Izmalkov <[email protected]>
Issue
Solution
Checklist