This website is built using Docusaurus 2, a modern static website generator.
$ npm install
$ npm run start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ npm run build
This command generates static content into the build directory and can be served using any static contents hosting service.
Search functionality is handled by a "local search" index built using (docusaurus-plugin-lunr)[https://github.com/daldridge/docusaurus-plugin-lunr]. Search is only available in a production build of the website. To view this locally run the following commands:
$ npm run build
$ npm run serve
When moving a file, create a client-side redirect so as not to break links from the old location. It is a best practice to also manually update old links to the new location whenever possible.
Add the new redirect to the websiteRedirects.json file. The format is:
{
from: ['/something-that-does-not-exist', '/something-that-does-not-exist/testing'],
to: '/key-concepts/anatomy-of-a-plugin',
},
from - being the old location and to being the new one. You can have multiple from urls for a single to url.
To test that the redirect works prior to publishing the PR deploy your branch to DEV Stage of developer portal. You can do so by running this action called Deploy to Developer Portal DEV Bucket.
Hit the run workflow button and choose following parameters:
- Use workflow from: Branch
main(keep it as it is by default) - Which branch to use? Here you should enter your branch name.
- Hit the
run workflowbutton