service/static-shim: simplify tutorial, remove SUBDIR authored by Jérôme Charaoui's avatar Jérôme Charaoui
and GIT_SUBMODULE_STRATEGY as the suggested values are already used as
the default values, document instead in Design section (next commit)
...@@ -31,27 +31,20 @@ like this: ...@@ -31,27 +31,20 @@ like this:
``` ```
variables: variables:
SITE_URL: example.torproject.org SITE_URL: example.torproject.org
SUBDIR: public/
include: include:
project: tpo/tpa/ci-templates project: tpo/tpa/ci-templates
file: static-shim-deploy.yml file: static-shim-deploy.yml
``` ```
The `SITE_URL` and `SUBDIR` parameters need to be changed to reflect, The `SITE_URL` parameter must reflect the FQDN of the website as
respectively, the FQDN of the website as defined in the defined in the `static-components.yml` file.
`static-components.yml` file, and the directory where the website was
built by the previous build stage. You may also need
`GIT_SUBMODULE_STRATEGY: recursive` if you have submodules (e.g. hugo
themes are often shipped as submodules).
For example, for <https://status.torproject.org>, the `.gitlab-ci.yml` For example, for <https://status.torproject.org>, the `.gitlab-ci.yml`
file looks like this (`build` stage elided for simplicity): file looks like this (`build` stage elided for simplicity):
variables: variables:
GIT_SUBMODULE_STRATEGY: recursive
SITE_URL: status.torproject.org SITE_URL: status.torproject.org
SUBDIR: public/
include: include:
project: tpo/tpa/ci-templates project: tpo/tpa/ci-templates
... ...
......