0c95cd3f59
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [docusaurus-plugin-openapi-docs](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs) ([source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/tree/HEAD/packages/docusaurus-plugin-openapi-docs)) | [`2.0.0-beta.3` -> `2.0.4`](https://renovatebot.com/diffs/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/2.0.4) | [![age](https://developer.mend.io/api/mc/badges/age/npm/docusaurus-plugin-openapi-docs/2.0.4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/docusaurus-plugin-openapi-docs/2.0.4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/2.0.4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/2.0.4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>PaloAltoNetworks/docusaurus-openapi-docs (docusaurus-plugin-openapi-docs)</summary> ### [`v2.0.4`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#204-Jan-18-2024) [Compare Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.3...v2.0.4) High level enhancements - Add x-codeSamples support - Add callbacks support Other enhancements and bug fixes - Add support to x-codeSamples ([#​697](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/697)) - Remove deprecated node packages ([#​699](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/699)) - Add Callbacks support ([#​691](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/691)) ### [`v2.0.3`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#203-Jan-9-2024) [Compare Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.2...v2.0.3) High level enhancements - Add callbacks support - Add markdown support to example/examples summary Other enhancements and bug fixes - Add markdown support to example summary ([#​690](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/690)) - Add Callbacks support ([#​691](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/691)) ### [`v2.0.2`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#202-Dec-5-2023) [Compare Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.1...v2.0.2) High level enhancements - Adds security schemes to API Explorer panel Other enhancements and bug fixes - Add missing security schemes component ([#​673](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/673)) ### [`v2.0.1`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#201-Dec-1-2023) [Compare Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.0...v2.0.1) High level enhancements - Improve support for handling multi-part form data Other enhancements and bug fixes - Improve support for handling multipart form data ([#​666](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/666)) - use SCHEMA_TYPE to distinguish request/response to support readOnly/writeOnly properties ([#​665](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/665)) - add negative look behind to exclude colon delimited path segments ([#​663](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/663)) - Update deploy-preview.yml - update v2.0.0 refs to v3.0.0 - Update pr-title-check.yaml - Update canary-beta-release.yml - Update README.md ### [`v2.0.0`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#200-Nov-13-2023) [Compare Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.0-beta.5...v2.0.0) High level enhancements - First v2.0.0 stable release! > Currently only compatible with Docusaurus v2.4.1 -> v2.4.3 Other enhancements and bug fixes - upgrade to react 18 and demo docusaurus to 2.4.3 ([#​656](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/656)) - allow upgrade to react 18 ([#​651](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/651)) - stop docusaurus support at v2.4.0 ([#​650](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/650)) ### [`v2.0.0-beta.5`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#200-beta5-Oct-23-2023) [Compare Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.0-beta.4...v2.0.0-beta.5) High level enhancements - Extend charset support for application/json - Improve webhook API page layout Other enhancements and bug fixes - Improve webhook layout ([#​646](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/646)) - update deprecation message ([#​644](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/644)) - allow charset support for application/json ([#​643](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/643)) - Reuse `createAnyOneOf` while creating a property ([#​628](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/628)) - Use `sass-loader` module as dependency ([#​639](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/639)) - Remove react nextui dependency in v2.0.0 ([#​641](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/641)) ### [`v2.0.0-beta.4`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#200-beta4-Sep-29-2023) [Compare Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.0-beta.3...v2.0.0-beta.4) High level enhancements - Expand capacity for building large sites by compressing frontmatter api property. Other enhancements and bug fixes - Fix `makeRequest()` for `formdata` request type ([#​625](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/625)) - \[UI] Cleanup schema item and explorer panel caret alignment ([#​624](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/624)) - revert v2.0.0 schema styles - Add support for anyOf properties and apply DRY to createSchema ([#​582](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/582)) - Adds compression support to frontmatter api prop ([#​606](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/606)) - Unify tabs naming ([#​612](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/612)) - \[Enhancement] Introduce new theme component names: ApiExplorer, CodeSnippets ([#​577](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/577)) - Use SchemaItem to render leaf discriminator properties/nodes ([#​573](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/573)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 7pm every weekday,before 5am every weekday" in timezone Europe/Madrid, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/Unleash/unleash). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xMjcuMCIsInVwZGF0ZWRJblZlciI6IjM3LjEzNS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> |
||
---|---|---|
.. | ||
docs | ||
remote-content | ||
src | ||
static | ||
.gitignore | ||
babel.config.js | ||
clean-generated-docs.js | ||
docusaurus.config.js | ||
global.js | ||
package.json | ||
README.md | ||
sidebars.js | ||
tsconfig.json | ||
vercel.json | ||
yarn.lock |
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
In a terminal, cd into the website folder of the locally cloned unleash repository and then start the installation.
cd unleash/website
yarn install
Generate OpenAPI docs
yarn generate
Generate the Open API docs that live at Reference documentation > APIs > OpenAPI
Local Development
Before running the docs the first time, you'll need to generate external documentation, as described in the generate OpenAPI docs section.
yarn start
Start a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
yarn build
This command generates static content into the build
directory and can be served using any static contents hosting service.
Deployment
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages
branch.
Troubleshooting
TypeError: source_default(...).bold is not a function
If you get an error like this, it's probably due to a formatting issue within one of the markdown files. It could be
- unescaped angle brackets (markdown will try to parse
<your-key>
(when it's not quoted) as HTML, which breaks the build) - incorrectly formatted titles or missing pieces of files
- a lot of other stuff.
Component Figure was not imported, exported, or provided by MDXProvider as global scope
TypeError: source_default(...).bold is not a function
[ERROR] Unable to build website for locale en.
This error is very hard to debug, but there is a trick that appears to work (as shared in this discussion on docusaurus' repo):
In node_modules/@docusaurus/core/lib/client/serverEntry.js
, remove all references to chalk
. You can use a regex replace for that, by replacing chalk(\w|\.)+
with the empty string.
Depending on your editor, that regex might need more escapes. For instance, here's a command to run with evil-ex
in Emacs:
%s/chalk\(\w\|\.\)+//g
For macOS sed
, it'd be:
sed -i '' 's/chalk\(\w\|\.\)\+//g' node_modules/@docusaurus/core/lib/client/serverEntry.js
For GNU sed
:
sed -i 's/chalk\(\w\|\.\)\+//g' node_modules/@docusaurus/core/lib/client/serverEntry.js
That might turn your error into something like this:
[ERROR] Docusaurus server-side rendering could not render static page with path /reference/api/unleash/change-requests.
[ERROR] Docusaurus server-side rendering could not render static page with path /reference/api/unleash/feature-types.
[ERROR] Docusaurus server-side rendering could not render static page with path /reference/api/unleash/frontend-api.
[ERROR] Docusaurus server-side rendering could not render static page with path /reference/api/unleash/maintenance.
[ERROR] Docusaurus server-side rendering could not render static page with path /reference/api/unleash/notifications.
[ERROR] Docusaurus server-side rendering could not render static page with path /reference/api/unleash/personal-access-tokens.
[ERROR] Docusaurus server-side rendering could not render static page with path /reference/api/unleash/segments.
[ERROR] Docusaurus server-side rendering could not render static page with path /reference/api/unleash/service-accounts.
[ERROR] Docusaurus server-side rendering could not render static page with path /reference/api/unleash/telemetry.
[ERROR] Docusaurus server-side rendering could not render static page with path /reference/api/unleash/unstable.
Component Figure was not imported, exported, or provided by MDXProvider as global scope
Error: Unexpected: cant find current sidebar in context
[ERROR] Unable to build website for locale en.