An open API service indexing awesome lists of open source software.

https://github.com/porter-dev/porter-docs

Documentation repository for Porter.
https://github.com/porter-dev/porter-docs

Last synced: 11 months ago
JSON representation

Documentation repository for Porter.

Awesome Lists containing this project

README

          

# Porter Documentation

Welcome to Porter's documentation repository! This contains the source code for the hosted docs at [https://docs.porter.run](https://docs.porter.run).

This website is built using [Docusaurus 2](https://docusaurus.io/), see the Docusaurus documentation [here](https://docusaurus.io/docs).

## Developing

Developing the site is as easy as `npm i` and `npm start`. This will open up a browser window on `localhost:3000`.

## Contributing

- **Minor fixes/typos** - please make a PR with the description of the current behavior and the changes that your PR is making.
- **Major updates to documentation** - please **file an issue first** if you would like to make a major update to existing documentation, and indicate that you would like to be assinged this issue.
- **New documentation** - please **file an issue first** and indicate that you would like to write this documentation.