The repository for afaik.institute website.

1. Clone this repository

$ git clone https://github.com/acid-info/afaik.institute.git

2. Install the dependencies:

$ yarn install

3. Start the website:

$ yarn start

4. Visit http://localhost:3000 in your browser

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
• Nimbus
• Nomos
• VacResearch
• Acid.info

Currently AFAIK.Institute is not supported in the businessUnit so the config uses Logos temporarily.

The code for a landing page is located in src/pages/index.mdx. This file employs the mdx format and utilizes React components from the Logos Docusaurus Plugins package.

To include subpages, create a .md or mdx file within the about directory. You can use Frontmatter to add metadata to your markdown file.

The content in about/index.md will be utilized as the index page for the /about section.

Subpages that do not belong to the About page (e.g., Terms of Use) can be situated in the root-pages directory.

You can find instructions for adding additional documentation sections, implementing localization, and managing versioning on the Docusaurus website.

Please note that theme customization is somewhat restricted; for more detailed instructions on customizing your theme, visit the Logos Docusaurus Theme repository.

By default, this template utilizes the CSS styles defined in the logos-docusaurus-plugins package. You have the option to define custom CSS in src/css/custom.scss.

1. Generate static files for production:

$ yarn build

The static files will be created in the build directory.

2. Serve the static build:

$ yarn serve

• CI builds master and pushes to deploy-master branch, which is hosted at https://afaik.institute//.

• CI builds develop and pushes to deploy-develop branch, which is hosted at https://dev.afaik.institute//.

• The hosting is done using Caddy server with Git plugin for handling GitHub webhooks.

Information about deployed build can be also found in /build.json available on the website.

1. Create a new working branch from develop: git checkout develop; git checkout -b my-changes.
2. Make your changes, push them to the origin, and open a Pull Request against the develop branch.
3. After approval, merge the pull request, and verify the changes on the staging server (e.g., https://dev.vac.dev).
4. When ready to promote changes to the live website, rebase the master branch on the staging changes: git checkout master; git pull origin master; git rebase origin/develop; git push.