vac.dev/README.md

• Description
• How to Run Locally
• Configuration
• Customization

Description

This repository contains the content of your documentation website.

How to Run Locally

1. Clone this repository.
2. Install the dependencies:

$ yarn

3. Start and open the website in your browser:

$ yarn start

Configuration

Edit the docusaurus.config.js file in the repository's root directory, and update the value of the businessUnit field in presets section; below is a list of valid values:

• Logos
• Codex
• Waku

Example:

presets: [
  [
    '@acid-info/logos-docusaurus-preset',
    {
      businessUnit: 'Codex',
    },
  ],
],

This is probably enough in most cases, as the Logos plugins will fill in other configurations related to the specified business unit. If you find any error in the information coming from Logos Plugins, please head over to Logos Docusaurus Plugins and create an issue.

Customization

You can find the instructions on adding more documentation sections, localization, and versioning on the Docusaurus website.

Note that theme customization is limited; for further instructions on customizing your theme, head over to Logos Docusaurus Theme.

Continuous Deloyment

• master branch is deployed to https://vac.dev by CI

• develop branch is deployed to https://dev.vac.dev by CI

Change Process

1. Create a new working branch from develop: git checkout develop; git checkout -b my-changes;
2. Proceed with changes, push to origin and open a Pull Request against develop;
3. Once approved, merge pull request, check changes on dev.vac.dev;
4. Once ready to promote to live website, rebase master on staging: git checkout master; git pull master; git rebase origin/develop; git push.