Piccadilly Circus Games Competition Website

Getting started

• Download Quarto
• Clone this repository
• In the root

  quarto render

Usage:

• Run quarto preview to serve the site in Quarto's local webserver
• Review the _quarto.yml file and Github Actions workflow for more details

Migrating from Hugo

For best results, clone into a new directory. However, if you are unable to do that, Delete the following directories as they will conflict and prevent Quarto from building:

 - themes/     # contains docys shortcodes
 - archetypes/ # contains docsy shortcodes
 - layouts/    # contains Markup for docsy templating
 - data/       # is empty and no longer required
 - docs/       # holds the content in a format that works for Hugo (and not Quarto).
 - content/    # holds the content in a format that works for Hugo (and not Quarto). 

Publication workflow

The repo is configured to publish:

• on merge to develop: to GitHub Pages site https://special-umbrella-26f3274a.pages.github.io/
• on merge to staging: to staging site https://staging.game.autonity.org
  • Staging site access credentials are in Bitwarden >> Autonity-org >> PCGC >> staging.game.autonity.org
• on merge to master: to production site https://game.autonity.org

Development workflow

• The master branch will always have the live production version of the website.
• A hot-fix to the production site is published by creating a branch from master with the hot-fix, and creating a PR. (Once the hot-fix has been merged, master should be merged to develop to ensure that the fix is propagated, and that conflicts are resolved in develop.)
• The develop branch will always have the WIP next version of the website being prepared.
• A new version of the production website is published by merging develop into master.

See the repo Wiki Page Git Workflow for when to merge or rebase branches when working on game.autonity.org repo.

Other Piccadilly site resources

For overall site structure, see Autonity Sitemap

• Piccadilly Testnet genesis configuration at https://docs.autonity.org/networks/testnet-piccadilly/#genesis-configuration
• Structure
  • Block explorer at https://piccadilly.autonity.org/ -- Blockscout, our standard config
  • Metrics at https://telemetry.piccadilly.autonity.org -- Grafana
  • ATN Faucet at https://faucet.autonity.org/
  • need to discuss further development needs (https://github.com/clearmatics/autonity-launch-plan/issues/60)
  • Public endpoints: (with standard setup (cloud based firewall, DDOS mitigations etc.):
    • RPC: https://rpc1.piccadilly.autonity.org:8545
    • WebSocket: wss://rpc1.piccadilly.autonity.org:8546
    • GraphQL: https://rpc1.piccadilly.autonity.org:8545/graphql
    • GraphQL Query UI: https://rpc2.bakerloo.autonity.org/graphql/ui
  • Website/documentation:
  • Piccadilly landing page (including the content of this repo): https://autonity.org/network.html
  • Piccadilly-specific technical documentation: https://docs.autonity.org/networks/testnet-piccadilly/

Contributing

To contribute to this repo, please raise a pull request as per Github Flow.

Note that in order to maintain a legible Git history, this repo enforces linear history on master. To ensure that your local Git commit log is linear, you should rebase your local changes on top of origin. You can tell Git to do this for this repository by setting the Git option pull.rebase in your local checkout:

git config --local pull.rebase true

Alternatively, you can apply this setting for all your repos by replacing --local with --global.

Reference: Pro Git by Scott Chacon