https://github.com/infinyon/fluvio-docs
📚 Documentation for Fluvio & InfinyOn Cloud
https://github.com/infinyon/fluvio-docs
docs docusaurus fluvio fvm infinyon sdf
Last synced: 10 months ago
JSON representation
📚 Documentation for Fluvio & InfinyOn Cloud
- Host: GitHub
- URL: https://github.com/infinyon/fluvio-docs
- Owner: infinyon
- Created: 2024-05-01T16:59:39.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-18T10:46:31.000Z (11 months ago)
- Last Synced: 2025-08-16T06:53:16.063Z (10 months ago)
- Topics: docs, docusaurus, fluvio, fvm, infinyon, sdf
- Language: MDX
- Homepage: https://fluvio.io
- Size: 20.7 MB
- Stars: 4
- Watchers: 6
- Forks: 10
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Changelog: news/images/0001/filter-odd.mov
Awesome Lists containing this project
README
## Contributing
### Prerequisites
- NodeJS (v20.11.1 or higher)
### Installation
```bash
$ npm install
```
### Development
Use `npm start` command to run the development server.
```bash
$ npm start
```
> [!NOTE]
> 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.
```bash
$ npm run build && npm run serve
```
The `build` command generates static content into the `build` directory and
can be served using any static contents hosting service.
### Create Versions
Theres 2 sets of docs available in this repo that are versioned:
- `fluvio`: The main documentation for Fluvio, which lives on `docs` dir
- `sdf`: The documentation for SDF, which lives on `sdf` dir
Doc | Version Command
--- | ---
`fluvio` | `npm run docusaurus docs:version `
`sdf` | `npm run docusaurus docs:version:sdf `
> [!WARNING]
> Versions specified in the command should not be prefixed with `v`.
## Release and Publish
In order to release a version and publish it you need to run:
```bash
./bin/release
```
This will tag current version, push the tag to the repository, which triggers a
Release process and a Publish process.
### Environments
Theres two environments for the documentation:
1. `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.
2. `Nightly`: The nightly environment is the development environment, it
contains the latest changes merged into the `main` branch.
## Dev tooling
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.