The Waku Documentation Portal can be accessed at https://docs.waku.org/ and was built using Docusaurus 2, a modern static website generator.
Clone this repository:
git clone https://github.com/waku-org/docs.waku.orgInstall the dependencies:
yarn
# or
yarn installyarn start # Run 'node fetch-content.js' in the root directory to fetch remote filesCheck for spelling errors before deploying:
yarn check:spellCreate a production build locally to check for errors:
yarn build # Runs 'node fetch-content.js' and then 'docusaurus build'
# The 'fetch-content.js' script fetches documents from the nwaku and research repositories.
# test the build
yarn serveEdit the docusaurus.config.js file located in the repository's root directory, and update the businessUnit field within the presets section. Here is a list of valid values for this field:
- Logos
- Codex
- Waku
Example:
presets: [
[
'@acid-info/logos-docusaurus-preset',
{
businessUnit: 'Waku',
},
],
],This should suffice since Logos plugins will handle other configurations linked to the designated business unit. However, if you encounter any inaccuracies in the data provided by Logos Plugins, please visit the Logos Docusaurus Plugins page and submit an issue.
You can find the instructions on adding more documentation sections, localisation, and versioning on the Docusaurus website.
Note that theme customisation is limited; for further instructions on customizing your theme, head over to Logos Docusaurus Theme.
Docusaurus depends heavily on caching to enhance site performance. If you make changes that do not appear in the portal, try clearing the cache by running:
yarn clear- CI builds
masterand pushes todeploy-masterbranch, which is hosted at https://docs.waku.org/. - CI builds
developand pushes todeploy-developbranch, which is hosted at https://dev-docs.waku.org/.
The hosting is done using Caddy server with Git plugin for handling GitHub webhooks.
Information about deployed build can be also found in /build.json available on the website.
- Create a new working branch from develop: git checkout develop; git checkout -b my-changes.
- Make your changes, push them to the origin, and open a Pull Request against the develop branch.
- After approval, merge the pull request, and verify the changes on the staging server (e.g., https://dev.vac.dev).
- When ready to promote changes to the live website, rebase the master branch on the staging changes: git checkout master; git pull origin master; git rebase origin/develop; git push.