Skip to content

Add archive and restore playbook documentation#8816

Merged
roberson-io merged 3 commits intomasterfrom
claude/issue-8815-20260313-1639
Mar 13, 2026
Merged

Add archive and restore playbook documentation#8816
roberson-io merged 3 commits intomasterfrom
claude/issue-8815-20260313-1639

Conversation

@roberson-io
Copy link
Contributor

@roberson-io roberson-io commented Mar 13, 2026

Add "Archive a playbook" and "Restore an archived playbook" sections after the "Duplicate a playbook" section in the share-and-collaborate page.

Closes #8815

Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added step-by-step guidance for archiving a playbook, including required permissions and illustrative imagery to support the workflow.
    • Added step-by-step guidance for restoring an archived playbook, including required permissions and illustrative imagery; positioned these sections alongside related playbook management topics for clearer navigation.

Co-authored-by: Michael Roberson <roberson-io@users.noreply.github.com>
@coderabbitai
Copy link

coderabbitai bot commented Mar 13, 2026

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: 64e2e0cc-a2f0-4527-8873-4a4987361c81

📥 Commits

Reviewing files that changed from the base of the PR and between 278c67a and 49e6c17.

📒 Files selected for processing (1)
  • source/end-user-guide/workflow-automation/share-and-collaborate.rst
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/end-user-guide/workflow-automation/share-and-collaborate.rst

📝 Walkthrough

Walkthrough

Adds two new documentation sections to the share-and-collaborate guide: "Archive a playbook" and "Restore an archived playbook", including permissions prerequisites, step-by-step instructions, and image references; inserted after "Duplicate a playbook" and before "Export channel data". No code changes.

Changes

Cohort / File(s) Summary
Documentation
source/end-user-guide/workflow-automation/share-and-collaborate.rst
Inserted two user-facing sections: "Archive a playbook" and "Restore an archived playbook". Each section includes required permissions, ordered procedural steps, and image references. Placement: after "Duplicate a playbook" and before "Export channel data".

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and clearly summarizes the main change: adding documentation sections for archiving and restoring playbooks.
Linked Issues check ✅ Passed The pull request fulfills all coding requirements from issue #8815: adds archive and restore playbook sections after the Duplicate section.
Out of Scope Changes check ✅ Passed All changes are directly related to adding the requested archive and restore playbook documentation sections; no unrelated modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch claude/issue-8815-20260313-1639
📝 Coding Plan
  • Generate coding plan for human review comments

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

@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 the current code and only fix it if needed.

Inline comments:
In `@source/end-user-guide/workflow-automation/share-and-collaborate.rst`:
- Around line 114-115: Replace external github user-attachments image URLs with
repo-hosted relative doc asset paths: locate the image directives like "..
image::
https://github.com/user-attachments/assets/d665e506-abb5-4005-bd67-aa9e4754bbe2"
in the share-and-collaborate.rst content and move the referenced image file into
the docs assets directory (e.g., docs/_static or docs/assets), then update the
directive to use a relative path (for example ".. image::
_static/your-image-name.png") and do the same for the other occurrence mentioned
(the similar directive at the block around the later lines).

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9eb04b59-b50f-48be-bd82-83dc2a7f2adf

📥 Commits

Reviewing files that changed from the base of the PR and between 0cce5d3 and 278c67a.

📒 Files selected for processing (1)
  • source/end-user-guide/workflow-automation/share-and-collaborate.rst

@github-actions
Copy link
Contributor

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

Co-authored-by: Michael Roberson <roberson-io@users.noreply.github.com>
@github-actions
Copy link
Contributor

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

- Add archive-a-playbook.gif showing the archive workflow
- Add restore-an-archived-playbook.gif showing the restore workflow
- Update image references from .png to .gif in documentation
@github-actions
Copy link
Contributor

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

@roberson-io roberson-io merged commit 23c7bf3 into master Mar 13, 2026
4 checks passed
@roberson-io roberson-io deleted the claude/issue-8815-20260313-1639 branch March 13, 2026 17:36
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.

Add how to archive a playbook and restore an archived playbook

1 participant