Go to file
Siddarth Kumar 64bc448fae
chore: update readme about CI jobs
2024-06-07 19:08:44 +05:30
.github docs: add issue and PR templates 2023-09-27 23:41:47 +09:00
docs chore: update security page 2024-06-04 02:44:22 +09:00
src docs: update terms content and preset version 2023-08-04 00:02:51 +09:00
static feat: add temporary landing page 2023-07-14 03:31:46 +09:00
.gitignore feat: add temporary landing page 2023-07-14 03:31:46 +09:00
Jenkinsfile chore: upgrade status-jenkins-lib to 1.8.16 2024-06-06 13:06:11 +02:00
README.md chore: update readme about CI jobs 2024-06-07 19:08:44 +05:30
babel.config.js switch to logos docu v1 2023-06-06 15:22:28 +02:00
docusaurus.config.js remove missing reference for about directory 2024-06-06 12:56:03 +02:00
package.json feat: add fathom analytics 2023-10-05 22:41:45 +09:00
sidebars.js switch to logos docu v1 2023-06-06 15:22:28 +02:00
tsconfig.json switch to logos docu v1 2023-06-06 15:22:28 +02:00
yarn.lock feat: add fathom analytics 2023-10-05 22:41:45 +09:00

README.md

AFAIK.Institure

The repository for afaik.institute website.

How to Run Locally

  1. Clone this repository
$ git clone https://github.com/acid-info/afaik.institute.git
  1. Install the dependencies:
$ yarn install
  1. Start the website:
$ yarn start
  1. Visit http://localhost:3000 in your browser

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

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

Landing Page

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.

Adding Subpages

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.

Root Pages

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

Docusaurus Config

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.

Custom CSS

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.

How to Run a Static Build (Production Build)

  1. Generate static files for production:
$ yarn build

The static files will be created in the build directory.

  1. Serve the static build:
$ yarn serve

CI/CD

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

Change Process

  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.