From f78b65dfb28e3fa0f78a8911def98bd189d18fff Mon Sep 17 00:00:00 2001 From: Sam Irons Date: Mon, 10 Aug 2026 14:37:53 +1000 Subject: [PATCH] inclusion of an updated contribution guide and tweaks to the readme to reflect new contribution guidance --- CONTRIBUTING.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 47 ++----------------------------- 2 files changed, 76 insertions(+), 45 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..d0002c22ff --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index 82fc6b55ff..d1e73d8d0c 100644 --- a/README.md +++ b/README.md @@ -13,24 +13,7 @@ See the [Octopus style guide](https://www.octopus.design/latest/brand/writing/ov ## How to contribute a change to the docs -- 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 master 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 - -### Default values - -When you need to use an example value in docs, please use the below: - -- 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, try to use "your" rather than "my". For example, `your-value`. +See [CONTRIBUTING.md](CONTRIBUTING.md) for how to propose a change, whether you're an Octopus staff member using the standards-driven workflow or contributing from outside Octopus. ## Required checks @@ -271,25 +254,7 @@ current, or when `data-shared-source="fallback"` shows up on a deployed page. ## Docs page layout guidelines -### Title icons - -If you are updating a page in Docs which doesn't already have a title icon, please add one. Title icons can be added in the frontmatter for each page by adding a Font Awesome class in the `icon` entry: - -```yaml ---- -layout: src/layouts/Default.astro -pubDate: 2023-01-01 -modDate: 2024-05-24 -title: Octopus Cloud -subtitle: We host Octopus for you -icon: fa-solid fa-cloud -navTitle: Overview -navSection: Octopus Cloud -navOrder: 10 -description: How to work with Octopus Cloud. -hideInThisSectionHeader: true ---- -``` +Page structure, frontmatter, and where version-specific notes belong are governed by the `octopus-docs-standards` skill in Claude Code — see [CONTRIBUTING.md](CONTRIBUTING.md). The guidance below covers page elements the content standards don't. ### Product screenshots @@ -302,11 +267,3 @@ Product screenshots used in Docs should reflect the UI in the latest version of ``` Images should be uploaded to the folder that relates to the position of the page in the Docs hierarchy. In the example above, where the image is destined for the Octopus Cloud overview page, the image has been uploaded to the Docs > Octopus Cloud > Images folder. If a folder has not been created for the page you are uploading an image to, create a new folder or use the Docs > Images folder as a backup. - -### Move version notes for older versions of Octopus to the bottom of Docs pages - -Do not use call out / info boxes in the main body of docs pages to reference how features worked in earlier versions of Octopus. This information should be moved to the bottom of docs pages under an 'Older versions' heading. For example, you might add a note like this under the 'Older versions' heading: - -```markdown -In versions earlier than 2024.x, you'll find the page to add a feed under the Projects menu -> Tenant Variables -```