Port is a Developer Platform made to make life easier for developers and DevOps in an organization, by creating a single platform that acts as a single source-of-truth for all of the infrastructure assets and operations existing in the organization's tech stack.
This is the repository for Port's documentation website (available at https://docs.getport.io)
Port's documentation is built using Docusaurus 2, a modern static website generator.
Our documentation is hosted using AWS Amplify.
Install NodeJS, it is recommended to use NVM to make installation and management of different NodeJS versions on the same machine easier:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
# After this, you can use nvm to install the latest version of node:
nvm install nodeIf you prefer installing NodeJS directly, please install the are not using NVM, just install the latest LTS version of Node.
Next, clone this repository and then in the project directory run:
npm installThen run:
npm run startThe docs will start running locally on https://localhost:4000
Port's documentation is open source because we want the documentation to be the most comprehensive resource for users to learn how to use Port. We believe that developers and DevOps professionals who use Port on a daily basis will want to contribute and help make it that comprehensive resource.
In order to learn how you can contribute to Port's documentation, read our contributing guide