omnomagonz/okteto-docs

The Okteto Documentation

This repository is the source for https://okteto.com/docs. If you'd like to contribute to the documentation, please first check out our contributing guide for info on how to get started.

Development

☁️ Develop With Okteto

• Install Okteto CLI
• Set your okteto context
• Clone the repo and run okteto up from the root of the repo

You should now see the docs deployed on http://localhost:8080/docs/ 🚀

💻 Develop locally

Clone the repo and then run:

yarn
yarn start

Version

To create a new version, run the following commands:

yarn install docusaurus
yarn run docusaurus docs:version 0.XX

This will create a new version with the docs on your current branch. Do this before you start merging the docs for the next version.

After this, modify docusaurus.config.js to add the version to the dropdown. We typically keep the last 6 versions in the dropdown.

Components

Product tiers list

Sometimes, documentation is specific to a product tier. You can add a badge beside headings using the TiersList component.

Usage

Tiers is a string of tier separated by a space

# Page heading<TiersList tiers="Scale Self-Hosted" />

Contributors

Made with contributors-img.