-
Notifications
You must be signed in to change notification settings - Fork 101
inclusion of an updated contribution guide and tweaks to the readme t… #3327
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
samironsoctopus
wants to merge
3
commits into
main
Choose a base branch
from
contribution-model-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # Contributing to the Octopus docs | ||
|
|
||
| Contributions to help improve this documentation are welcome. How you contribute depends on whether you're an Octopus staff member or contributing from outside Octopus. | ||
|
|
||
| ## Octopus staff | ||
|
|
||
| Anyone at Octopus can improve the documentation, whether you're fixing a page you found confusing or writing something new. | ||
|
|
||
| This section covers the essentials for working directly in this repository. For the complete guide — including a path for drafting content without touching git, current reviewer logistics, and where to get help — see the [Documentation contribution and review guide](INSERT-LINK-HERE). | ||
|
|
||
| You don't need to know the content standards yourself. The `octopus-docs-standards` and `octopus-writing-guide` skills in Claude Code apply them for you. | ||
|
|
||
| ### Get set up | ||
|
|
||
| - [Claude Code](https://claude.com/product/claude-code) (submit an Access Requests ticket if you don't have this). | ||
| - Access to the [internal Claude Code plugins marketplace](https://github.com/OctopusDeploy/octopus-claude-internal-plugins). | ||
|
|
||
| To install the docs skills, add the marketplace from within Claude Code, then install the plugin: | ||
|
|
||
| ```text | ||
| /plugin marketplace add https://github.com/OctopusDeploy/octopus-claude-internal-plugins | ||
| ``` | ||
|
|
||
| ```text | ||
| /plugin | ||
| ``` | ||
|
|
||
| Confirm you can build the site locally (see "Deploying to preview environment" below), and confirm you have the `octopus-docs-standards` skill by asking Claude directly. | ||
|
|
||
| ### Make your change | ||
|
|
||
| Plan the edit with Claude before you change anything. Point it at the source file and ask for an assessment, not a rewrite: | ||
|
|
||
| > Assess this page against our documentation standards. What can I do to bring it up to standard? And what's the smallest useful change to bring it closer to spec? | ||
|
|
||
| Then make the edits with the agent, working section by section rather than regenerating the whole page. | ||
|
|
||
| Never invent specifics. If a fact isn't confirmed — a version number, an error string, a setting name — the agent should mark it (`[VERIFY: ... — needs: ...]` or `[PLACEHOLDER: ... — needs: ...]`) instead of guessing. Resolve or remove every marker before you submit for review. | ||
|
|
||
| ### Check it before you submit | ||
|
|
||
| - Ask the agent to review its own work against the standards and writing guide, then read the result yourself — you're accountable for what ships. | ||
| - Confirm outgoing links resolve, and check for incoming anchor links you may have broken by renaming or removing a heading. | ||
| - Build the page locally and look at it. This catches MDX problems the source hides, like a `:::` block nested inside another `:::`. | ||
| - Markdown lint, spelling, and broken links are also checked automatically on submit (see "Required checks" below) — get them green before you ask for review. | ||
|
|
||
| ### Submit and review | ||
|
|
||
| Put your change on a new branch and open a pull request. Carry your plan into the description so a reviewer can check intent against result. | ||
|
|
||
| Review confirms the structure matches the agreed page type, the frontmatter is complete, and no facts were invented or markers left behind — often with the agent's help. The one thing no tool can check is accuracy, so make sure your reviewer has subject-matter expertise for the area you changed. See the [Documentation contribution and review guide](INSERT-LINK-HERE) for who's reviewing during the current documentation uplift. | ||
|
|
||
| ### Writing conventions | ||
|
|
||
| When you need an example value in docs, use the following: | ||
|
|
||
| - Octopus URL: `https://your-octopus-url` | ||
| - Octopus API key: `API-YOUR-KEY` | ||
| - Snapshot name: `Snapshot XXXXX` | ||
| - SubscriptionId: `g3662re9njtelsyfhm7t` | ||
| - Fake password: `your-secret-password` | ||
|
|
||
| In general, prefer "your" over "my". For example, `your-value`. | ||
|
|
||
| ## External contributors | ||
|
|
||
| - The `main` branch has the latest version of the docs. | ||
| - Fork this repo and create a branch for your changes. | ||
| - Make the changes you'd like to contribute. | ||
| - Submit a pull request (PR) to `main` with your changes and include a comment explaining the changes. | ||
| - Sign the [Contribution License Agreement (CLA)](https://cla-assistant.io/OctopusDeploy/docs). | ||
| - We'll review your PR and accept it or suggest changes. | ||
|
|
||
| See the [Octopus style guide](https://www.octopus.design/latest/brand/writing/overview-VLYeW2mi-VLYeW2mi) for voice, grammar, and formatting conventions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not opposed to claude being helpful here, but I don't think it should be the only way people can access information such as our content standards. I don't have the octopus deploy claude plugins installed, for example.