💡 Prerequisite: Make sure the docker is running.
- Change to the folder
aps-infra-platformin your local clone of the repo
cd <./<path>/aps-infra-platform>- Pull the image in
dockerand use it to preview your content as follows:
docker pull ghcr.io/bcgov/devhub-techdocs-publish
docker run -it -p 3000:3000 -v $(pwd):/github/workspace ghcr.io/bcgov/devhub-techdocs-publish preview-
Open
CMDwith Admin privileges. -
Run
Powershell. This will help in executing the below commands in powershell. -
Change to the folder
aps-infra-platformin your local clone of the repo
cd <./<path>/aps-infra-platform>- Pull the image in
dockerand use it to preview your content as follows:
docker pull ghcr.io/bcgov/devhub-techdocs-publish
docker run -it -p 3000:3000 -v ${pwd}:/github/workspace ghcr.io/bcgov/devhub-techdocs-publish previewStart a "preview" web server on http://localhost:3000 for you to review your
content. When the documents configured in the mkdocs.yml file are edited, the
changes will be live-updated on the local site.
For more help, check INDEX.MD in DevHub.
First run the local preview. Then:
npm install -g @umbrelladocs/linkspector
linkspector checkSee https://github.com/UmbrellaDocs/linkspector
Alternatively, you can view the results of htmltest which runs as part of the
DevHub TechDocs build process. Search the build logs for htmltest to find the
results.
💡 Prerequisite:
golang
mkdir _tmp
cd _tmp
git clone https://github.com/bcgov/gwa-cli
cd gwa-cli
just docs
cp docs/gwa-commands.md ../../documentation/reference/gwa-commands.mdUse this tag when introducing key concepts. Most often this will be in an introductory / overview section.
{{ glossary_tooltip term_id="api-services-portal" text="API Services Portal" }}
term_id: The term to reference, defined in scripts/glossary_reference.yaml.
Must be passed first as first attribute.
text (optional): The displayed text. If not provided, the name (in Title
Case) is used.
The result is the display text specially styled with a tooltip including the
definition and a link to a relevant reference URL (if defined in
glossary_reference.yaml).
A GitHub Actions workflow is used to deploy the docs to DevHub. The workflow is
triggered by a push to the main or test branches - pushing to main will
deploy to the prod environment
(https://developer.gov.bc.ca/docs/default/component/aps-infra-platform-docs/),
and pushing to test will deploy to the test environment
(https://dev.developer.gov.bc.ca/docs/default/component/aps-infra-platform-docs/).
You can also manually trigger the workflow from the Actions tab
to deploy a working branch to the test environment. Use the Run workflow
dropdown to select the branch you want to deploy.
See the workflow file for details.