Skip to content

README.md

Latest commit

 

History

History
71 lines (45 loc) · 2.41 KB

README.md

File metadata and controls

71 lines (45 loc) · 2.41 KB

Organization website

This repository stores the source of Computorg.

How to contribute to the website

Quarto

Our website has been built with Quarto, an open-source scientific and technical publishing system. The first thing you need to compile the website is therefore to install Quarto, which can be done by downloading the corresponing installer here: https://quarto.org/docs/get-started/.

Positron

If you are using the new Positron IDE, quarto is already bundled with it. You can simply type which quarto within the built-in terminal in Positron and add the returned path to your PATH.

Microsoft DotNet SDK

You need to install Microsoft DotNet SDK which is now v10.0. Installers can be found here: https://dotnet.microsoft.com/en-us/download. Otherwise, you can install it on Unix systems via:

  • Linux:
sudo apt-get install dotnet-sdk-10.0
  • macOS:
brew install dotnet

GitHub Personal Access Token

You need to connect to your GitHub account.

  • Go under Settings, scroll down until you see the Developer settings tab on the left sidebar and click on it. Follow the procedure to create a classic personal access token (PAT). Give it a name you will remember and remember to copy the PAT before closing the page.
  • Put the token in a file named .env-secret in the root of this repository
API_GITHUB_TOKEN=your_github_token

Refresh local publication metadata

The publication metadata is generated locally from the Computorg GitHub repositories before the site is rendered. The refresh step updates these generated files:

  • site/published.yml
  • site/published.xml
  • site/pipeline.yml
  • site/mock-papers.yml

To refresh only the publication metadata, run:

dotnet run --project src/Build.fsproj -- -t UpdatePublications

This command runs the PublicationUpdater.Cli app through the FAKE build entrypoint and writes the generated metadata files into site/.

If you want to refresh the metadata and then rebuild the full website, run:

dotnet run --project src/Build.fsproj

The default build target runs publication refresh first and then executes quarto render.

If you only need to render the site from already-generated metadata, run:

dotnet run --project src/Build.fsproj -- -t RenderSite

Now, you can compile the website with dotnet run --project src/Build.fsproj.