docs: fix broken code, command, and link examples#9012
Conversation
Several examples across the admin and deployment guides don't run or render as written: - comply/electronic-discovery: the curl example had the closing single quote after the URL, putting the URL inside the Authorization header value. Moved it to right after the token. - configure/CJK search: missing semicolon after CREATE EXTENSION zhparser. - manage/health-check-probes: the Go import used a github.com/.../tree/master web URL and an unbalanced quote; replaced with the real import path. - onboard/sso-entraid: the Microsoft Entra ID hyperlink was missing its opening backtick, so it didn't render as a link. - scale/enterprise-search: opensearch used triple backticks; reStructuredText inline literals are double backticks (elasticsearch on the same line is). - upgrade/admin-onboarding-tasks: cross-reference display text read 'mmctl user deletall'; the command is deleteall (the ref target spells it). - upgrade/upgrading-postgres: the catalog is pg_statistic, not pg_statistics. - desktop/linux-install: rpm upgrade flag is -U, not -u. - server/linux/deploy-tar: 'rm - rf' had a stray space inside the flag.
|
Hello @emmayusufu, Thanks for your pull request! A Core Committer will review your pull request soon. For code contributions, you can learn more about the review process here. Per the Mattermost Contribution Guide, we need to add you to the list of approved contributors for the Mattermost project. Please help complete the Mattermost contribution license agreement? This is a standard procedure for many open source projects. Please let us know if you have any questions. We are very happy to have you join our growing community! If you're not yet a member, please consider joining our Contributors community channel to meet other contributors and discuss new opportunities with the core team. |
|
Too much diff to scan? Review this PR in Change Stack to start with the highest-impact changes. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (9)
📝 WalkthroughWalkthroughThis pull request corrects nine isolated documentation issues across administration and deployment guides: fixing curl header formatting in API examples, updating code imports and markup syntax, adding missing SQL statement terminators, correcting PostgreSQL table references, updating CLI command parameters and references, and fixing malformed command syntax. ChangesDocumentation corrections across administration and deployment guides
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsStopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
|
/check-cla |
1 similar comment
|
/check-cla |
2 participants
While reading through the admin and deployment guides I found several examples that don't run or render as written. Each is a small, self-contained fix:
curlexample's closing single quote was after the URL, so the URL ended up inside theAuthorizationheader value and no request URL was passed. Moved the quote to right after the token.CREATE EXTENSION zhparser(the next statement on the following line has one).github.com/.../tree/master/...web URL with an unbalanced quote; replaced with the real import path"github.com/mattermost/mattermost/server/public/model".opensearchused triple backticks; reStructuredText inline literals are double backticks (the adjacentelasticsearchuses double).mmctl user deletall; the command isdeleteall(the ref target itself spells it that way).pg_statistic, notpg_statistics.rpmupgrade flag is-U, not-u(-uisn't a valid rpm option).rm - rfhad a stray space inside the flag.9 files, all one-line fixes. I'll sign the CLA so this can be merged.