This repository contains the documentation for Octopus Deploy.

Contributions to help improve this documentation are welcome, however, you must sign the Contribution License Agreement (CLA) before we can accept your contribution.

See the Octopus style guide for information including:

• Markdown quick reference
• Capitalization
• Working with images
• Predefined snippets to include in your text

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)
• We'll review your PR and accept it or suggest changes

Deploying to preview environment (Octopus Developers)

Before merging to main it's possible you'd like to see your changes in a preview environment. It's simple to do this:

1. You need Node.js installed to run the site locally
2. Run pnpm install to obtain the dependencies
3. Run pnpm dev to run a local preview of the site
4. Open localhost:3000 to view the site, the first page load usually takes a little time

You can generate a static copy of the site using pnpm build and run it in a browser with pnpm preview.