Documentation for the FairOS. View at https://docs.fairos.fairdatasociety.org/docs/.
You must use node 14 or above. We recommend nvm.
$ npm i
$ npm start
This command starts a local development server and open 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.
Don't forget to find and replace the version number for the whole of the docs folder.
NOTE: when this is done, the docs will have to be rebuilt.
- Get the OpenAPI YAML source files from which the documentation is generated. They can be found in the openapi folder of fairOS-dfs repo.
- Generate the
index.html
file for the API docs via :npx redoc-cli bundle dfs.yaml -o ./static/api/index.html --disableGoogleFont --options.expandDefaultServerVariables "true"
- Rebuild and redeploy docs.
This documentation is provided under the Creative Commons License