Skip to content

Add docs links#8975

Merged
amyblais merged 8 commits into
masterfrom
amyblais-docslinks
May 15, 2026
Merged

Add docs links#8975
amyblais merged 8 commits into
masterfrom
amyblais-docslinks

Conversation

@amyblais
Copy link
Copy Markdown
Member

No description provided.

Copilot AI review requested due to automatic review settings May 15, 2026 07:31
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Mattermost v11 changelog entry for a channel membership API endpoint by adding a documentation link.

Changes:

  • Adds a link around “API endpoint” in the v11.7 API changes section.
  • Leaves the endpoint description and surrounding changelog content unchanged.

Comment thread source/product-overview/mattermost-v11-changelog.md Outdated
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 15, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ee23f2dd-1192-4fd3-bdeb-9d67fb46c406

📥 Commits

Reviewing files that changed from the base of the PR and between 029ea5b and 42c9023.

📒 Files selected for processing (3)
  • source/product-overview/desktop-app-changelog.md
  • source/product-overview/mattermost-v11-changelog.md
  • source/product-overview/mobile-app-changelog.md
✅ Files skipped from review due to trivial changes (3)
  • source/product-overview/desktop-app-changelog.md
  • source/product-overview/mobile-app-changelog.md
  • source/product-overview/mattermost-v11-changelog.md

📝 Walkthrough

Walkthrough

Changelog files were edited to convert specific plain-text labels into Markdown links: v11.7 entries (Improvements, Plugins, API Changes), the desktop v6.2 macOS MDM line, and two mobile v2.40.0 Improvements bullets now include documentation hyperlinks.

Changes

Changelog documentation update

Layer / File(s) Summary
Mattermost v11.7 changelog link updates
source/product-overview/mattermost-v11-changelog.md
“User Attributes” (Improvements), “AI Actions Menu” (Plugins), and the PUT /api/v4/channels/{channel_id}/members phrase “a JSON object” (API Changes) are wrapped as Markdown links to their respective documentation.
Desktop and mobile changelog link updates
source/product-overview/desktop-app-changelog.md, source/product-overview/mobile-app-changelog.md
The desktop v6.2 macOS entry now uses “macOS MDM” with a documentation link; the v2.40.0 mobile Improvements bullets wrap “mobile support” and “team name” wording in documentation links.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • mattermost/docs#8973: Updates v2.40.0 mobile release changelog references and linking related to v11.7 cross-references.
  • mattermost/docs#8901: Edits the desktop-app changelog macOS MDM entry wording/linkage.
  • mattermost/docs#8899: Introduces the v2.40 section that this PR further adjusts by hyperlinking specific Improvements entries.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive No pull request description was provided by the author; however, the changes are documentation-only with clear intent evident from the raw summary and file modifications. Consider adding a brief description explaining the purpose and scope of adding documentation links to the changelog entries.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Add docs links' directly and accurately reflects the core change in the pull request: adding documentation hyperlinks to multiple changelog entries across three files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch amyblais-docslinks

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@source/product-overview/mattermost-v11-changelog.md`:
- Line 136: Replace the absolute URL
"https://docs.mattermost.com/administration-guide/comply/embedded-json-audit-log-schema.html"
in the changelog line that describes the new PUT
/api/v4/channels/{channel_id}/members endpoint with the repo's internal relative
doc link (e.g. /administration-guide/comply/embedded-json-audit-log-schema or
/administration-guide/comply/embedded-json-audit-log-schema.md); ensure you use
the project's preferred internal link syntax and correct file extension (.md or
.rst) so the link remains internal and maintainable.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 613aca21-720a-4cf5-ac17-797639293b6c

📥 Commits

Reviewing files that changed from the base of the PR and between 84ccd00 and 029ea5b.

📒 Files selected for processing (1)
  • source/product-overview/mattermost-v11-changelog.md

Comment thread source/product-overview/mattermost-v11-changelog.md Outdated
@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 029ea5b

@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 5bd12da

@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA b191153

@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA dd4992e

@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA c4029de

@amyblais amyblais changed the title Update mattermost-v11-changelog.md Add docs links May 15, 2026
@amyblais amyblais added the 2: Editor Review Requires review by an editor label May 15, 2026
@amyblais amyblais requested review from Combs7th and devinbinnie May 15, 2026 07:42
@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA e7f4377

@amyblais amyblais requested a review from wiggin77 May 15, 2026 07:42
@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 42c9023

@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 68ee4eb

@amyblais amyblais merged commit 74a5cb7 into master May 15, 2026
6 checks passed
@amyblais amyblais removed the 2: Editor Review Requires review by an editor label May 15, 2026
@amyblais amyblais deleted the amyblais-docslinks branch May 15, 2026 13:08
@amyblais amyblais removed request for Combs7th and wiggin77 May 15, 2026 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants