Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/port-labs/port-docs
The open-source repo for docs.getport.io
https://github.com/port-labs/port-docs
developer-platform developer-portal documentation docusaurus-v3
Last synced: 3 days ago
JSON representation
The open-source repo for docs.getport.io
- Host: GitHub
- URL: https://github.com/port-labs/port-docs
- Owner: port-labs
- License: other
- Created: 2022-04-18T11:24:05.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-15T11:11:10.000Z (7 months ago)
- Last Synced: 2024-04-15T22:56:47.456Z (7 months ago)
- Topics: developer-platform, developer-portal, documentation, docusaurus-v3
- Language: CSS
- Homepage: https://docs.getport.io
- Size: 109 MB
- Stars: 53
- Watchers: 7
- Forks: 25
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Port Documentation
## Introduction
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.
## Port's documentation
This is the repository for Port's documentation website (available at [https://docs.getport.io](https://docs.getport.io))
Port's documentation is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
Our documentation is hosted using [AWS Amplify](https://aws.amazon.com/amplify/).
## Installation
Install [NodeJS](https://nodejs.org), it is recommended to use [NVM](https://github.com/nvm-sh/nvm#install--update-script) to make installation and management of different NodeJS versions on the same machine easier:
```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
```
If you prefer to install NodeJS manually, please refer to the [`.nvmrc`](./.nvmrc) file to see what version the docs are currently using.
Now, clone the repository of Port's documentation and follow the instructions:
### If you use `nvm`
```bash
# cd to the directory of the docs and run
nvm install
nvm use
npm install
npm run start
```
### If you installed NodeJS manually
```bash
# cd to the directory of the docs and run
npm install
npm run start
```
The docs will start running locally on [https://localhost:4000](https://localhost:4000)
## Contributing
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](./CONTRIBUTING.md)