This document covers the process for contributing to the articles and code samples that are hosted on the Octopus Deploy documentation site.
Articles are stored in this repository as Markdown files. Simple changes to the content of a Markdown file can be made in the github editor and submitted for review via a pull request (PR). We will review the PR and accept it or suggest changes.
No issue is required to be created before hand, however we still need you to sign the Contribution License Agreement (CLA) before we can accept your contribution.
You'll need a basic understanding of Git and GitHub.com.
- Open an issue describing what you want to do, such as change an existing article or create a new one.
- Fork this repo and create a branch for your changes.
- Submit a pull request (PR) to master with your changes.
- Sign the Contribution License Agreement (CLA)
The site is rendered using markdig, Markdig supports GitHub Flavored Markdown as well as some extra syntax.
For all the syntax and conventions used in articles read our README.md.
Our goal is to write documentation that is easily understandable by the widest possible audience. To that end we have established guidelines for writing style that we ask our contributors to follow. For more information, see Voice and tone guidelines.
If you delete an article, change its file name, or move it to a different folder, create a redirect so that people who bookmarked the article won't get 404s. Read this section on how to add redirects.