kirstenschwarzer / docs Goto Github PK

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

• 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

When you raise a pull request, the following checks will take place:

1. A full test
2. A spell-check

You can run the tests locally using:

pnpm test

The most common failures are:

• A new image is referenced with the wrong path
• An internal link has a bad address

You can run the spell check locally using:

pnpm spellcheck

Only changed files are checked for spelling. If a file hasn't been edited since this check was introduced, you may have to fix some old spelling issues.

For each error detected, you'll need to decide whether to:

• Correct your spelling, or
• Propose an addition to the custom dictionary

For example, if you added MySQL to an article and it was flagged as an unknown word, you could propose the addition of MySQL by adding it word list in the file dictionary-octopus.txt.

Some consideration should be given as to whether it should be MySQL or MySql and just a single entry should be added to dictionary-octopus.txt to promote consistency.

You can see files excluded from the spell check in cspell.json.

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.