Skip to content

Commit 27b40af

Browse files
mkernohanbcmkernohanbc
authored
DevHub creating new files for TechDocs. (#578)
1 parent 374a542 commit 27b40af

10 files changed

Lines changed: 445 additions & 0 deletions

File tree

‎.github/workflows/publish.yaml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Build TechDocs with DevHub TechDocs Publish Action
2+
permissions:
3+
contents: read
4+
on:
5+
workflow_dispatch:
6+
push:
7+
branches: [ main ]
8+
paths:
9+
- "mkdocs.yml"
10+
- "docs/*"
11+
- "catalog-info.yaml"
12+
pull_request:
13+
branches: [ main ]
14+
paths:
15+
- "mkdocs.yml"
16+
- "docs/*"
17+
- "catalog-info.yaml"
18+
19+
jobs:
20+
test_techdocs_build_job:
21+
runs-on: ubuntu-latest
22+
23+
name: A job to build and publish techdocs content
24+
steps:
25+
- name: Checkout
26+
uses: actions/checkout@v4
27+
with:
28+
fetch-depth: '0'
29+
- name: Build TechDocs
30+
uses: bcgov/devhub-techdocs-publish@stable
31+
id: build_and_publish
32+
with:
33+
publish: 'false' # publishing disabled initially - content will be built, but not published. repositories need to be granted access to TechDocs secrets explicitly by the DevEx team before publishing would work, so we disable to prevent the workflow from failing.
34+
# the parameters below can be uncommented when publishing is enabled and secrets have been exposed to the repo
35+
# production: ${{ github.ref == 'refs/heads/main' && 'true' || 'false' }} # example of only pushing to prod DevHub when changes that triggered the job are in main branch
36+
# bucket_name: ${{ secrets.TECHDOCS_S3_BUCKET_NAME }}
37+
# s3_access_key_id: ${{ secrets.TECHDOCS_AWS_ACCESS_KEY_ID }}
38+
# s3_secret_access_key: ${{ secrets.TECHDOCS_AWS_SECRET_ACCESS_KEY }}
39+
# s3_region: ${{ secrets.TECHDOCS_AWS_REGION }}
40+
# s3_endpoint: ${{ secrets.TECHDOCS_AWS_ENDPOINT }}
41+

‎LICENSE_CONTENT‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README_TECHDOCS.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
[![Package Status](https://github.com/bcgov/design-system/actions/workflows/publish.yaml/badge.svg)](https://github.com/bcgov/design-system/actions/workflows/publish.yaml)
2+
3+
4+
# b.c.-design-system
5+
6+
The B.C. Design System helps public sector design and development teams build consistent, accessible products.
7+
8+
## About
9+
10+
This is a default [README.md](README.md) file generated by the template. Customize it for your project.
11+
12+
13+
## Adding documentation
14+
15+
The homepage of your documentation is in the [docs/index.md](docs/index.md) file. Edit it to suit your usage. Warning: do not delete this file.
16+
17+
Add documentation pages by adding more markdown (.md) files to the [docs](docs) folder.
18+
19+
## Table of contents
20+
21+
The Table of Contents on the right is dynamically generated based on the set of hierarchy
22+
of headings in your markdown files. Only use one H1 (`#` in Markdown) per file.
23+
24+
## Site navigation
25+
26+
It is optional, but ***highly recommended*** that you create define the navigation structure for your documentation by creating a `nav` section in your [mkdocs.yml](mkdocs.yml) file. Without a `nav` section, navigation for your documentation will be dynamically created when viewed within DevHub, but you won't have control over the order in which the pages show and the text will be generated based on the headings in the pages themselves.
27+
28+
Creating a `nav` section will allow you to completely control how the navigation for your documentation displays in DevHub, including the text that is shown, grouping pages in categories and sub-categories and including links to external content.
29+
30+
We've includes some example `mkdocs.yml` files below which demonstrate how to configure the `nav` section. You may also wish to consult the [MkDocs documentation](https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation) for detailed information about navigation and other aspects of mkdocs.yml.
31+
32+
### `nav` with categories
33+
34+
Below is an example of a `mkdocs.yml` file with a `nav` section. This `nav` section is structure to arrange the files in categories. In this case the categories are `Getting Started` and `Usage`.
35+
36+
```yaml
37+
site_name: My TechDocs
38+
site_description: Documentation for my project
39+
docs_dir: "docs"
40+
edit_uri: edit/main/docs/
41+
plugins:
42+
- techdocs-core
43+
- ezlinks
44+
markdown_extensions:
45+
- markdown_inline_mermaid
46+
- md_in_html
47+
- mkpatcher:
48+
location: patcher.py
49+
nav:
50+
- Getting Started:
51+
- Introduction: index.md
52+
- Create an account: account.md
53+
- Setup environment: setup.md
54+
- Usage:
55+
- Deploy locally: local.md
56+
- Deploy to OpenShift: openshift.md
57+
```
58+
59+
### Flat `nav`
60+
61+
Below is another example of a `mkdocs.yml` file. It does not use categories to arrange the documentation pages.
62+
63+
```yaml
64+
site_name: My Techdocs
65+
site_description: Documentation for my project
66+
docs_dir: "docs"
67+
plugins:
68+
- techdocs-core
69+
- ezlinks
70+
markdown_extensions:
71+
- markdown_inline_mermaid
72+
- md_in_html
73+
- mkpatcher:
74+
location: patcher.py
75+
nav:
76+
- Introduction: index.md
77+
- Create an account: account.md
78+
- Setup environment: setup.md
79+
- Deploy locally: local.md
80+
- Deploy to OpenShift: openshift.md
81+
```
82+
83+
## Notes
84+
85+
Note that MkDocs uses `mkdocs.yml`, not `mkdocs.yaml`, although both appear to work.
86+
Refer to the [mkdocs user guide](https://www.mkdocs.org/user-guide/configuration/) for more details.
87+
88+
## Previewing documentation locally
89+
90+
You will likely want to preview your documentation on your computer. Follow [these instructions](https://github.com/bcgov/devhub-techdocs-publish/blob/main/docs/index.md#how-to-use-the-docker-image-to-preview-content-locally) to do so.
91+
92+
## Building and publishing your documentation
93+
94+
The [GitHub Action workflow file](.github/workflows/publish.yaml) can validate, build (produce browser-friendly HTML from Markdown) and publish your documentation to DevHub automatically. Initially, it is set up just to validate and build your documentation.
95+
96+
The portion of the workflow file that publishes your documentation is commented out because it requires addition set up with the Developer Experience team. When you'd like to have your documentation published in DevHub, [contact the Developer Experience Team](mailto:developer.experience@gov.bc.ca) who will work with you to set things up.
97+
98+
### The publishing workflow
99+
100+
DevHub has a "preview" environment and a production environment, and once the Developer Experience team has you set up, and you've uncommented the publishing sections in the [workflow file](.github/workflows/publish.yaml) you'll be in control of how and when your content is published to each. You'll be able to control this by modifying the [workflow file](.github/workflows/publish.yaml) to suit your process and team.
101+
102+
The configuration provided in the [workflow file](.github/workflows/publish.yaml) behaves as follows:
103+
104+
* A pull request to your repo will build and publish the code to the [DevHub preview](https://dev.developer.gov.bc.ca) site. This is a development site where you can preview your changes.
105+
* A push to the `main` branch in your repository (a direct push or a PR merge) will publish the code to the [production DevHub website](http://developer.gov.bc.ca).
106+
107+
## Getting help or reporting an issue
108+
109+
To report bugs/issues/features requests, please email the Developer Experience team at [Developer.Experience@gov.bc.ca](mailto:Developer.Experience@gov.bc.ca)
110+
111+
The full documentation for MkDocs (which is powering the DevHub TechDocs function) is at the [MkDocs website](https://www.mkdocs.org/user-guide/writing-your-docs/). Note that not all content on the site will be applicable to DevHub's use of MkDocs.
112+
113+
## Contributing
114+
If you would like to contribute, please see our [contributing](CONTRIBUTING.md) guidelines.
115+
116+
Please note that this project is released with a [Contributor Code of Conduct](CODE-OF-CONDUCT.md). By participating in this project you agree to abide by its terms.
117+
118+
## License
119+
120+
© 2024 Province of British Columbia
121+
122+
Refer to the [LICENSE](LICENSE.md) file for more information.
123+

0 commit comments

Comments
 (0)