Skip to content

Commit 9a5a142

Browse files
committed
chore: docs
update docs image and readme instructions
1 parent 424dc49 commit 9a5a142

File tree

5 files changed

+7
-1
lines changed

5 files changed

+7
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,4 @@ mds.json
5757
# mkdocs
5858
__pycache__
5959
site
60+
venv

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,6 @@ repository for keycloak images and helm chart
1212
## Devhub Docs
1313

1414
Devhub docs are generated using [Techdocs](https://backstage.io/docs/features/techdocs/cli/), a cli tool. To run locally:
15+
- `python -m venv venv`
16+
- `pip install -r requirements.txt`
1517
- `npx @techdocs/cli serve --verbose --no-docker`

requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
pre-commit==2.9.3
22
gitlint==0.15.1
3+
mkpatcher==1.0.2
4+
mkdocs-ezlinks-plugin==0.1.14
5+
mkdocs==1.6.0
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
You have been redirected to this page because your github account is not affiliated with the organization `bcgov`.
22
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`.
33

4-
<img height="200" src="https://user-images.githubusercontent.com/56739669/202020559-4ec40037-82a4-4cd3-89e6-127c41a849fc.png" >
4+
![Github Organization Help](./img/github-organization-help.png){: style="width:300px; height:300px"}
55

66

77
### [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).

wiki/img/github-organization-help.png

26.7 KB
Loading

0 commit comments

Comments
 (0)