Logz API Website

Local deployment

1. Run:

git clone https://<YOUR-PAS>@github.com/logzio/logz-api.git

2. Cd to the root folder:

cd logz-api

3. Add Docusaurus api plugin:

yarn add docusaurus-plugin-openapi-docs

yarn add docusaurus-theme-openapi-docs

4. Start local build:

yarn start

Update api specs

1. Follow local deployment instructions

2. Update the api spec under examples/logzio-public-api.yml

3. Delete the relevant mdx file which you updated in the spec

4. Run plugin generate command

yarn docusaurus gen-api-docs logz

Adding new pages/categories

1. Follow local deployment instructions

2. Update the api spec under examples/logzio-public-api.yml. Divide the sections using # ::::: NAME and create a unique URL, summary, and operationId.

3. Add the new section to the relevant section under sidebar.js. Each category starts with "type":"category", and each page starts with "type":"doc". The ID and label should be unique.

4. Save your changes and run the plugin generate command yarn docusaurus gen-api-docs logz to generate the new page you created.