The documentation built with Docusaurus.
The search is implemented using DocSearch.
The OpenAPI documentation is generated using PaloAltoNetworks docusaurus-openapi-docs plugin.
- Install the dependencies
npm install
- Run application in development mode
npm run start
- For production ready build use the next commands:
npm run gen-all
npm run build
Note: To serve the documentation on base path other than /docs/
follow the next steps:
- create a file
.env
in the project root - Add
DOCS_BASE_URL=/
with your preferred base path.
Each changes pushing (direct pushing or via merging a Pull Request) to the:
develop
branch will trigger the deployment to the dev environment to AWS S3 bucket.master
branch will trigger the deployment to the prod environment to GitHub Pages (https://reportportal.io/docs).
If you would like to contribute to the docs, feel free to open your Pull Requests to the default branch.