Merge pull request #352 from bcgov/ssoteam-1736

chore: docs
bcgov · Jun 3, 2024 · dfadbf1 · dfadbf1
2 parents 424dc49 + 9a5a142
commit dfadbf1
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -57,3 +57,4 @@ mds.json
 # mkdocs
 __pycache__
 site
+venv
diff --git a/README.md b/README.md
@@ -12,4 +12,6 @@ repository for keycloak images and helm chart
 ## Devhub Docs
 
 Devhub docs are generated using [Techdocs](https://backstage.io/docs/features/techdocs/cli/), a cli tool. To run locally:
+- `python -m venv venv`
+- `pip install -r requirements.txt`
 - `npx @techdocs/cli serve --verbose --no-docker`
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,5 @@
 pre-commit==2.9.3
 gitlint==0.15.1
+mkpatcher==1.0.2
+mkdocs-ezlinks-plugin==0.1.14
+mkdocs==1.6.0
diff --git a/wiki/Are-you-part-of-the-GitHub-BC-Gov-Org.md b/wiki/Are-you-part-of-the-GitHub-BC-Gov-Org.md
@@ -1,7 +1,7 @@
 You have been redirected to this page because your github account is not affiliated with the organization `bcgov`.
 To find out if you are affiliated, go to your github profile and look at the organizations you are associated with. You will not see `bcgov`.
 
-<img height="200" src="https://user-images.githubusercontent.com/56739669/202020559-4ec40037-82a4-4cd3-89e6-127c41a849fc.png" >
+![Github Organization Help](./img/github-organization-help.png){: style="width:300px; height:300px"}
 
 
 ### [If you need to be included in this org, please read and follow the instructions here](https://docs.developer.gov.bc.ca/bc-government-organizations-in-github/#organizations-in-github).
diff --git a/wiki/img/github-organization-help.png b/wiki/img/github-organization-help.png
-Original file line number
+Diff line change
@@ Expand Up / @@ -57,3 +57,4 @@ mds.json @@
     # mkdocs
     __pycache__
     site
+    venv