README.md

xpanse Website

xpanse website is built using Docusaurus 3, a modern static website generator.

Installation

$ npm

Local Development

$ npm 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.

Production Deployment

The website is currently deployed on Eclipse Foundation's infrastructure. All changes that are pushed to main branch will trigger a re-deployment of the website.

In case the website needs to be deployed anywhere else, then run the below command and copy the contents generated in the build folder to any server that can server static websites.

npm run build

Icons

Free icons on this website are taken from Lucide.

Dependencies File

All third-party related content is listed in the DEPENDENCIES file.

Vale Linter

We use Vale Linter for our documentation validation. The linter is part of the CI job and any finding will make the job to fail.

Running Vale Linter Locally

To run the Vale linter locally, we must download the rules packages manually to .github/vale/styles folder as mentioned below.

copy files from https://github.com/errata-ai/packages/tree/master/pkg/Google/Google to .github/vale/styles/Google
copy files from https://github.com/errata-ai/packages/tree/master/pkg/Microsoft/Microsoft to .github/vale/styles/Microsoft

Execute the linter by running the following commands

docker pull jdkato/vale
docker run --rm -v $(pwd)/.github/vale/styles:/styles --rm -v $(pwd):/docs -w /docs jdkato/vale .