From eaca83871a50521c85181a6e2f39d765e5dd9fb0 Mon Sep 17 00:00:00 2001 From: Scaffolder Date: Tue, 21 May 2024 20:47:34 +0000 Subject: [PATCH] DevHub creating new repository for TechDocs. --- .github/workflows/publish.yaml | 40 ++++++++++ .gitignore | 3 + CODE_OF_CONDUCT.md | 132 +++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 8 ++ LICENSE | 97 ++++++++++++++++++++++++ README.md | 123 ++++++++++++++++++++++++++++++ catalog-info.yaml | 16 ++++ docs/about-us.md | 7 ++ docs/configuration.md | 7 ++ docs/getting-started.md | 7 ++ docs/index.md | 14 ++++ docs/tips-and-tricks.md | 7 ++ mkdocs.yml | 16 ++++ pubcode.yaml | 10 +++ 14 files changed, 487 insertions(+) create mode 100644 .github/workflows/publish.yaml create mode 100644 .gitignore create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 catalog-info.yaml create mode 100644 docs/about-us.md create mode 100644 docs/configuration.md create mode 100644 docs/getting-started.md create mode 100644 docs/index.md create mode 100644 docs/tips-and-tricks.md create mode 100644 mkdocs.yml create mode 100644 pubcode.yaml diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml new file mode 100644 index 0000000..fd0a5e4 --- /dev/null +++ b/.github/workflows/publish.yaml @@ -0,0 +1,40 @@ +name: Build TechDocs with DevHub TechDocs Publish Action + +on: + workflow_dispatch: + push: + branches: [ main ] + paths: + - "mkdocs.yml" + - "docs/*" + - "catalog-info.yaml" + pull_request: + branches: [ main ] + paths: + - "mkdocs.yml" + - "docs/*" + - "catalog-info.yaml" + +jobs: + test_techdocs_build_job: + runs-on: ubuntu-latest + + name: A job to build and publish techdocs content + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: '0' + - name: Build TechDocs + uses: bcgov/devhub-techdocs-publish@stable + id: build_and_publish + with: + 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. +# the parameters below can be uncommented when publishing is enabled and secrets have been exposed to the repo +# 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 +# bucket_name: ${{ secrets.TECHDOCS_S3_BUCKET_NAME }} +# s3_access_key_id: ${{ secrets.TECHDOCS_AWS_ACCESS_KEY_ID }} +# s3_secret_access_key: ${{ secrets.TECHDOCS_AWS_SECRET_ACCESS_KEY }} +# s3_region: ${{ secrets.TECHDOCS_AWS_REGION }} +# s3_endpoint: ${{ secrets.TECHDOCS_AWS_ENDPOINT }} + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d1db6cc --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +patcher.py +test_patcher.py +site/ \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..f5b0491 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available +at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..af3b888 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +## How to contribute +Government employees, public and members of the private sector are encouraged to contribute to this repository by **forking and submitting a pull request**. + +(If you are new to GitHub, you might start with a [basic tutorial](https://help.github.com/articles/set-up-git) and check out a more detailed guide to [pull requests](https://help.github.com/articles/using-pull-requests/).) + +Pull requests will be evaluated by the repository maintainers for incrporation into the repository. + +All contributors retain their original copyright, but by contributing to this project, grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users **under the terms of the [license](LICENSE) under which this project is distributed.** diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9ed0eb5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,97 @@ +CC BY 4.0 + +**Creative Commons Attribution 4.0 International Public License** + +https://creativecommons.org/licenses/by/4.0/legalcode + +By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. + +**Section 1 – Definitions.** + +Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. +Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. +Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. +Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. +Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. +Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. +Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. +Licensor means the individual(s) or entity(ies) granting rights under this Public License. +Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. +Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. +You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. +**Section 2 – Scope.** + +License grant. +Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: +reproduce and Share the Licensed Material, in whole or in part; and +produce, reproduce, and Share Adapted Material. +Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. +Term. The term of this Public License is specified in Section 6(a). +Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. +Downstream recipients. +Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. +No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. +No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). +Other rights. + +Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. +Patent and trademark rights are not licensed under this Public License. +To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. + +**Section 3 – License Conditions.** + +Your exercise of the Licensed Rights is expressly made subject to the following conditions. + +Attribution. + +If You Share the Licensed Material (including in modified form), You must: + +retain the following if it is supplied by the Licensor with the Licensed Material: +identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); +a copyright notice; +a notice that refers to this Public License; +a notice that refers to the disclaimer of warranties; +a URI or hyperlink to the Licensed Material to the extent reasonably practicable; +indicate if You modified the Licensed Material and retain an indication of any previous modifications; and +indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. +You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. +If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. +If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License. + +**Section 4 – Sui Generis Database Rights.** + +Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: + +for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; +if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and +You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. +For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. + +**Section 5 – Disclaimer of Warranties and Limitation of Liability.** + +Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You. +To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You. +The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. + +**Section 6 – Term and Termination.** + +This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. +Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: + +automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or +upon express reinstatement by the Licensor. +For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. +For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. +Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +**Section 7 – Other Terms and Conditions.** + +The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. +Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. + +**Section 8 – Interpretation.** + +For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. +To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. +No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. +Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b7e9c8a --- /dev/null +++ b/README.md @@ -0,0 +1,123 @@ +[![Package Status](https://github.com/bcgov/mlg-test-repo-14/actions/workflows/publish.yaml/badge.svg)](https://github.com/bcgov/mlg-test-repo-14/actions/workflows/publish.yaml) + + +# test-docs + +more test + +## About + +This is a default [README.md](README.md) file generated by the template. Customize it for your project. + + +## Adding documentation + +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. + +Add documentation pages by adding more markdown (.md) files to the [docs](docs) folder. + +## Table of contents + +The Table of Contents on the right is dynamically generated based on the set of hierarchy +of headings in your markdown files. Only use one H1 (`#` in Markdown) per file. + +## Site navigation + +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. + +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. + +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. + +### `nav` with categories + +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`. + +```yaml +site_name: My TechDocs +site_description: Documentation for my project +docs_dir: "docs" +edit_uri: edit/main/docs/ +plugins: + - techdocs-core + - ezlinks +markdown_extensions: + - markdown_inline_mermaid + - md_in_html + - mkpatcher: + location: patcher.py +nav: +- Getting Started: + - Introduction: index.md + - Create an account: account.md + - Setup environment: setup.md +- Usage: + - Deploy locally: local.md + - Deploy to OpenShift: openshift.md +``` + +### Flat `nav` + +Below is another example of a `mkdocs.yml` file. It does not use categories to arrange the documentation pages. + +```yaml +site_name: My Techdocs +site_description: Documentation for my project +docs_dir: "docs" +plugins: + - techdocs-core + - ezlinks +markdown_extensions: + - markdown_inline_mermaid + - md_in_html + - mkpatcher: + location: patcher.py +nav: + - Introduction: index.md + - Create an account: account.md + - Setup environment: setup.md + - Deploy locally: local.md + - Deploy to OpenShift: openshift.md +``` + +## Notes + +Note that MkDocs uses `mkdocs.yml`, not `mkdocs.yaml`, although both appear to work. +Refer to the [mkdocs user guide](https://www.mkdocs.org/user-guide/configuration/) for more details. + +## Previewing documentation locally + +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. + +## Building and publishing your documentation + +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. + +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. + +### The publishing workflow + +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. + +The configuration provided in the [workflow file](.github/workflows/publish.yaml) behaves as follows: + +* 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. +* 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). + +## Getting help or reporting an issue + +To report bugs/issues/features requests, please email the Developer Experience team at [Developer.Experience@gov.bc.ca](mailto:Developer.Experience@gov.bc.ca) + +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. + +## Contributing +If you would like to contribute, please see our [contributing](CONTRIBUTING.md) guidelines. + +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. + +## License + +© 2024 Province of British Columbia + +Refer to the [LICENSE](LICENSE.md) file for more information. + diff --git a/catalog-info.yaml b/catalog-info.yaml new file mode 100644 index 0000000..3ae77be --- /dev/null +++ b/catalog-info.yaml @@ -0,0 +1,16 @@ +apiVersion: backstage.io/v1alpha1 +kind: Component +metadata: + name: test-docs + title: test docs + description: more test + annotations: + github.com/project-slug: bcgov/mlg-test-repo-14 + backstage.io/techdocs-ref: dir:. + bcgovpubcode.gov.bc.ca/ministry: CITZ + developer.gov.bc.ca/source_template: default/docs-template + backstage.io/source-template: template:default/docs-template +spec: + type: documentation + lifecycle: experimental + owner: group:bcgov/developer-experience diff --git a/docs/about-us.md b/docs/about-us.md new file mode 100644 index 0000000..ae4f37c --- /dev/null +++ b/docs/about-us.md @@ -0,0 +1,7 @@ +# About us + +## Suggested Content + +Introduce your team or project for a more in-depth understanding for your users + + diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..3ed2ced --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,7 @@ +# Configuration + +## Suggested Content + +* Explain configuration/customization requirements, if necessary +* Guide on tailoring the service to specific needs +* Provide instructions for integrating with other systems if needed \ No newline at end of file diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 0000000..eb25c5b --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1,7 @@ +# Getting started + +## Suggested Content +* Provide step-by-step instructions for system setup +* List prerequisites and system requirements +* Determine if visual aids are necessary for better comprehension, keeping in mind to [create accessible content](https://digital.gov.bc.ca/wcag/home/intro/) and review the [accessibility and inclusion toolkit](https://www2.gov.bc.ca/gov/content/home/accessible-government/toolkit) +* Address common issues and provide troubleshooting solutions \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..1774f05 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,14 @@ +# test docs + +more test + +**This file is the homepage of your documentation. It is mandatory and must not be deleted.** + +## Suggested content + +* Clearly define the purpose and functionality of your service, project, or application + * Leverage [Service Definition](https://github.com/BCDevOps/openshift-wiki/blob/0ff5d39f767e89b1b8fac8ccda9901b3e18a672a/docs/OCP/ServiceDefinition.md) structure that exists for several services already +* Highlight key features and advantages +* Emphasize main functionalities +* How to get support + diff --git a/docs/tips-and-tricks.md b/docs/tips-and-tricks.md new file mode 100644 index 0000000..53aea05 --- /dev/null +++ b/docs/tips-and-tricks.md @@ -0,0 +1,7 @@ +# Tips and tricks + +## Suggested Content + +* Contribute to the overall success of a development project +* Promote efficiency, code quality, collaboration, security, and adaptability +* Ensure the knowledge base required aligns with your entire audience; assess if it suits their needs \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..ad4909b --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,16 @@ +site_name: "test docs" +site_description: "more test" +docs_dir: "docs" +repo_url: "https://github.com/bcgov/mlg-test-repo-14" +edit_uri: edit/main/docs +nav: + - Introduction: index.md + - Getting started: getting-started.md + - Configuration: configuration.md + - Tips and tricks: tips-and-tricks.md + - About us: about-us.md +plugins: + - techdocs-core + - git-revision-date-localized +markdown_extensions: + - md_in_html diff --git a/pubcode.yaml b/pubcode.yaml new file mode 100644 index 0000000..8854c71 --- /dev/null +++ b/pubcode.yaml @@ -0,0 +1,10 @@ +version: 1 +data_management_roles: + product_owner: +product_information: + ministry: CITZ + product_acronym: + product_description: more test + product_name: +product_technology_information: + hosting_platforms: Not-Applicable