- NodeJS (v20.11.1 or higher)
$ npm installUse npm start command to run the development server.
$ npm startNote
The Search support is not available when running for development, if you want to test the search functionality, you need to run the build and serve the build directory.
Build Test
Build the solution for publishing and then serve bundle files using a static server.
$ npm run build && npm run serveThe build command generates static content into the build directory and
can be served using any static contents hosting service.
Theres 2 sets of docs available in this repo that are versioned:
fluvio: The main documentation for Fluvio, which lives ondocsdirsdf: The documentation for SDF, which lives onsdfdir
| Doc | Version Command |
|---|---|
fluvio |
npm run docusaurus docs:version <VERSION> |
sdf |
npm run docusaurus docs:version:sdf <VERSION> |
Warning
Versions specified in the command should not be prefixed with v.
In order to release a version and publish it you need to run:
./bin/releaseThis will tag current version, push the tag to the repository, which triggers a Release process and a Publish process.
Theres two environments for the documentation:
-
Production: The production environment is the default environment, it contains the latest stable version of the documentation. This environment is released when tagging a version. -
Nightly: The nightly environment is the development environment, it contains the latest changes merged into themainbranch.
If you are analyzing broken links, you can optionally use some external
link analyzers. The staps are tasks in the Justfile. This uses
the just task runner.
On macos: brew install just, on debian/ubuntu based linux: apt install just
Other environments https://github.com/casey/just#packages
just will list targets,
just lint will build the full static site and generate a hyperlink.log file containing broken links.