Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 1.63 KB

Contributing

This website is built using Docusaurus (facebook/docusaurus), a modern static website generator.

Run locally

Make sure Node.js (version 18.0 or above) is installed.

Install the dependencies:

npm install

Start the local development server (by default it opens a window in the browser on localhost:3000):

npm start

From there, you can edit the files and see changes in live in the browser.

To see the search in action, build and use the results to run the website:

npm run build
npm run serve

Customization

Important

Make sure to review this customizations when doing upgrades

Table of contents width

Idea found on discussion #8799:

npm run swizzle @docusaurus/theme-classic -- DocItem/Layout

Files are in src/theme/DocItem/Layout.

Tip

Run the command to see what is possible to swizzle:

npm run swizzle @docusaurus/theme-classic -- --list

Lint before committing

Reproduce locally GitLab jobs:

mkdir -p .gitlab/runner/local
docker run --rm --name gitlab-runner -v /var/run/docker.sock:/var/run/docker.sock -v $PWD/.gitlab/runner/local/config:/etc/gitlab-runner -v $PWD:$PWD --workdir $PWD gitlab/gitlab-runner exec docker lint-markdown
docker run --rm --name gitlab-runner -v /var/run/docker.sock:/var/run/docker.sock -v $PWD/.gitlab/runner/local/config:/etc/gitlab-runner -v $PWD:$PWD --workdir $PWD gitlab/gitlab-runner exec docker lint-yaml