docs

DevSpace CLI Documentation

This documentation is created with Docusaurus.

Contributing

To contribute code,

1. Fork the project
2. Clone the DevSpace CLI project: git clone https://github.com/[YOUR_USERNAME]/devspace && cd devspace/docs
3. Start a DevSpace for the docs page: devspace dev
4. Make changes
5. Test your changes on: http://localhost:3000/docs/introduction
6. Commit changes
7. Push commits
8. Open pull request

Docusaurus allows you to use hot reloading when editing the docs pages, so you can now edit any docs page in ./docs and Docusaurus will recompile the markdown and reload the website automatically.

Contribution Guidelines

For general information regarding contributions see: Contribution Guidelines

Creating New Versions

1. Generate Command Docs

cd ../ # main project directory
go run -mod= ./hack/gen-docs.go

2. Create Version

cd website
npm run version v4.0.3

3. Update Sidebars

If there is a new sidebar file in website/versioned-sidebars/ that means the sidebar has changed and you need to:

• (if needed:) create a new CSS style for the sidebar in website/static/css/versions/SIDEBAR_VERSION/style.css
• APPEND the DevSpace version as key to the sidebarVersions objects inside website/core/Footer.js and define which sidebar version (value) should be used