The Postman Open Technologies Docs is the main repository behind the technical documentation that lives at https://learning.postman.com/open-technologies/. The content hosted there has been created with our community for our community and is available for community contributions.
We would love for you to contribute to the Open Technologies docs! To contribute to this project, please read:
NOTE: We've added a new Markdown linter with GitHub Actions. When making a pull request, it will run against this linter. Your changed files are required to pass linting before they will be merged. More information on this can be found in the contribution guidelines.
The Docs are build with ReactJS, GatsbyJS Framework and styled components for styling.
The primary header on top and the footer consume the header and footer API from Postman Marketing Engineering. The secondary top navbar as well as the left and right navbars are custom to this project.
$ git clone https://github.com/postmanlabs/open-technologies-docs.git
$ cd open-technologies-docs
$ npm run nvmrc
$ nvm use
$ npm install
$ npm install -g gatsby-cli
$ npm run dev
NOTE: This site was built with Node.js v14.17.1. We recommend installing and using nvm and setting your Node.js version to v14.17.1.
TLDR;
The usual GitHub PR process. You can run this repo locally on your machine, or you can make changes to the content by editing the Markdown files in https://github.com/postmanlabs/open-technologies-docs/tree/develop/src/pages to develop the content only.