From bde3761bc32f19c1260abe1e960df03f7dd04bac Mon Sep 17 00:00:00 2001 From: Jonah Aragon Date: Wed, 10 Apr 2024 16:00:52 -0500 Subject: [PATCH] d --- .github/workflows/build.yml | 5 +++-- README.md | 16 +++------------- 2 files changed, 6 insertions(+), 15 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 98d7709311..d3fe96a215 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -58,8 +58,9 @@ jobs: if: inputs.config == 'offline' run: | { + echo "BUILD_EDIT_URI_TEMPLATE=''" echo "BUILD_OFFLINE=true" - echo "BUILD_REPO_URL="" + echo "BUILD_REPO_URL=''" echo "CARDS=false" echo "HOMEPAGE_BUTTON_GET_STARTED_LINK=basics/why-privacy-matters.html" echo "HOMEPAGE_BUTTON_TOOLS_LINK=tools.html" @@ -190,7 +191,7 @@ jobs: - name: Build Website (Unprivileged) if: ${{ !inputs.privileged }} run: | - mkdocs build --config-file ${{ inputs.config_file }} + mkdocs build mkdocs --version - name: Package Website diff --git a/README.md b/README.md index f88db60829..84b7de41ba 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ Committing to this repository requires [signing your commits](https://docs.githu ### With `mkdocs-material` 1. Install required packages: `pip install mkdocs-material` -2. Run a local preview of the English site: `mkdocs serve --config-file config/mkdocs.en.yml` +2. Run a local preview of the English site: `mkdocs serve` ### With `mkdocs-material-insiders` @@ -126,23 +126,13 @@ This website uses [`mkdocs-material-insiders`](https://squidfunk.github.io/mkdoc 3. Install Python **3.12**. 4. Install **pipenv**: `pip install pipenv` 5. Install dependencies: `pipenv install --dev` (install [Pillow and CairoSVG](https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#dependencies) as well to generate social cards) -6. Serve the site locally: `MKDOCS_INHERIT=mkdocs-production.yml pipenv run mkdocs serve --config-file config/mkdocs.en.yml` (set `CARDS=true` to generate social cards) +6. Serve the site locally: `pipenv run mkdocs serve --config-file mkdocs-production.yml` (set `CARDS=true` to generate social cards) - The site will be available at `http://localhost:8000` - - You can build the site locally with `MKDOCS_INHERIT=mkdocs-production.yml pipenv run mkdocs build --config-file config/mkdocs.en.yml` + - You can build the site locally with `pipenv run mkdocs build --config-file mkdocs-production.yml` - This version of the site should be identical to the live, production version If you commit to `main` with commits signed with your SSH key, you should add your SSH key to [`.allowed_signers`](/.allowed_signers) in this repo. -### Local Translated Site Builds - -1. Install the [Crowdin CLI Tool](https://developer.crowdin.com/cli-tool) (`brew install crowdin`) -2. Set the `CROWDIN_PERSONAL_TOKEN` environment variable to your Crowdin personal access token -3. Run `crowdin download` in the root of this repo -4. Import the language's environment variables: `set -a; source includes/strings.fr.env; set +a` (replacing fr with the appropriate language) -5. Serve the site locally: `pipenv run mkdocs serve --config-file config/mkdocs.fr.yml` (replacing fr with the appropriate language in [/config](/config)) - -Translations downloaded from Crowdin are [.gitignore](/.gitignore)'d, so any local changes to the translated site cannot be committed to this repo. Actual modifications need to be made on Crowdin. As an alternative to steps 1-3, you can copy the folders from [privacyguides/i18n](https://github.com/privacyguides/i18n) to the root of this repo to obtain the translated files. - ## Releasing It is required to create a GitHub release to publish the current site to privacyguides.org. The current `main` branch can be previewed at [https://main.staging.privacyguides.dev](https://main.staging.privacyguides.dev) prior to release.