hartl3y94 / docs

Octopus Deploy documentation

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

• 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 master it's possible you'd like to see your changes in a preview environment. It's simple to do this:

1. Navigate to TeamCity.
2. Find the build configuration for the environment you want to preview the changes in. They live under the Octofront / CPT project and the build configuration will be prefixed with Docs.
3. Select Run... and choose your branch to build the docs and deploy it to the preview environment.
4. Make a note of the preview environment base url (this is available in the build-configuration description) and then preview your changes using that url.

Note: You may need to refresh the preview environment several times as various caching layers are invalidated. It may take a minute or two between when the pipeline completes and your changes become visible.

For more detailed information about the build process and preview environments, take a look at the internal documentation (private link).