Docs

Docs is the product that contains our documentation.

Surprising, isn't it?

Public Oath

1. The documentation is located at: docs.fluidattacks.com.

Architecture

1. Docs is a static site built with Docusaurus, JavaScript, Graphviz, and Markdown.
2. At build time, we generate search indexes to leverage search functionality through Algolia, and transform the .dot source files into SVG format using Graphviz.
3. Once built, its static content is deployed to an S3 bucket on Amazon Web Services (AWS).
4. All of the media content (images, videos, etc) is stored (and served from) Cloudinary.
5. The domain's registrar is Cloudflare, which also proxies incoming traffic from the users through the Cloudflare network (CDN, Firewall, etc), and caches the content for some time using Page Rules. Before a request is returned to the user, a Cloudflare Worker adds HTTP security headers like the Content-Security-Policy. In top of this, we have a few redirections from doc to docs, just in case a user forgets the s.
6. In order to allow developers to test their changes, an ephemeral environment is deployed from their Git branch into docs-dev.fluidattacks.com/<branch>. So that they can check that everything is OK before opening a Merge Request on GitLab.

tip

You can right-click on the image below to open it in a new tab, or save it to your computer.

Contributing

Please read the contributing page first.

Development Environment

Follow the steps in the Development Environment section of our documentation.

When prompted for an AWS role, choose dev, and when prompted for a Development Environment, pick docs.

Local Environment

Just run:

universe $ m . /docs start

This will launch a replica of docs.fluidattacks.com on your localhost, port 3000, which you can interactively develop and test.