Gnosis Chain Documentation

Overview

This repo contains the contents for our docs deployed here.

The website is built using Docusaurus 2.

Contributing

The Documentation is an ecosystem tool, we welcome everybody to collaborate and improve it! See the contributing page for details.

Release process

Releases to production are managed through the creation of a tagged version.

This step-by-step guide will walk you through getting ready for the deployment.

1. Create a Pull Request to merge dev branch onto the main branch, ask code maintainers to review and approve the PR

2. Once merged, create a tagged version in the form of vMayor.Minor.Patch. For this you can simply use your terminal to create the tagged version

    git tag v0.17.3                // example tag 

    git push origin v0.17.3       // example tag 

3. Wait for the CIs to run, the CI will craft a Github release automatically containing the release notes, check the release out in releases

4. Go to Actions page, search for Manual deployment to production, here the link.

   • click on Run workflow, this will open a drop-down menu
   • Set use workflow from main (it doesn't perform any actions on our CIs, but Github is still asking for a proper value)
   • Provide the version to deploy in the form of vMayor.Minor.Patch
   • refresh the page, a new job will be marked as running, enter the job to check the logs out

5. A notification is sent on Slack to the DevOps team containing the project being deployed, the version and the name of the user who triggered the action

Analytics

Product analytics run on PostHog's EU cloud. The setup is in src/clientModules/analytics.js.

• No cookies. PostHog runs in cookieless mode: nothing is stored in the browser, and visitors are counted with a daily-salted hash on PostHog's servers, so the site needs no cookie banner.
• Production only. The production deployment passes the POSTHOG_PROJECT_KEY repository variable to the build as POSTHOG_KEY. Builds without it, dev and local ones included, load nothing.

Pageviews and page leaves feed PostHog's Web Analytics (visitors, referrers, UTM campaigns, devices).

To try it locally, start the site with any key:

$ POSTHOG_KEY=phc_test pnpm start

Then add ?__posthog_debug=true to the URL: the console logs every event PostHog sends.

Credits

Some content in this site was adapted or inherited from the work done by Andrew, Igor and team on the development of xDai. We thank them for the great job done!