From 9f74fa91228683ef2da473a9f8a2fff315a15d27 Mon Sep 17 00:00:00 2001 From: Raik Bitters Date: Mon, 5 Feb 2024 08:34:04 +0000 Subject: [PATCH 1/2] Update build commands in README.md and package.json --- README.md | 3 ++- package.json | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b3609f433..10886b105 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,9 @@ npm install npm run start ``` -3. For production ready build use the next command: +3. For production ready build use the next commands: ```bash +npm run gen-all npm run build ``` diff --git a/package.json b/package.json index 20e81a1e6..e07367110 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "description": "ReportPortal Documentation", "scripts": { "docusaurus": "docusaurus", - "start": "docusaurus start", + "start": "npm run re-gen && docusaurus start", "build": "docusaurus build", "lint": "eslint src/**/*.{js,jsx}", "format": "npm run lint -- --fix", From bf173da9e248fcf2fd1ace79b5ff7c12b0d6447f Mon Sep 17 00:00:00 2001 From: Raik Bitters Date: Mon, 5 Feb 2024 08:37:54 +0000 Subject: [PATCH 2/2] Add OpenAPI documentation generation plugin --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 10886b105..90491cf87 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@ The documentation built with [Docusaurus](https://docusaurus.io). The search is implemented using [DocSearch](https://docsearch.algolia.com). +The OpenAPI documentation is generated using +[PaloAltoNetworks docusaurus-openapi-docs plugin](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs). + ## Running locally 1. Install the dependencies