Readme docs

web/site/CODE_OF_CONDUCT.md

@@ -0,0 +1,70 @@
+# Code of Conduct - SBC API Gateway
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, 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.
+
+## 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
+* 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
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban
+temporarily or permanently any contributor for other behaviors that they deem
+inappropriate, threatening, offensive, or harmful.
+
+## 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 e-mail 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 <>. ADD CONTACT?
+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.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
+[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
+[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
+and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).

web/site/CONTRIBUTING.md

@@ -0,0 +1,141 @@
+<!-- omit in toc -->
+# Contributing to SBC API Gateway
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. We forward to your contributions. 🎉
+
+<!-- omit in toc -->
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+- [How to Contribute](#how-to-contribute)
+- [Code Owners](#code-owners)
+- [Reporting Bugs](#reporting-bugs)
+- [Suggesting Enhancements](#suggesting-enhancements)
+<!-- - [Your First Code Contribution](#your-first-code-contribution)
+- [Improving The Documentation](#improving-the-documentation)
+- [Styleguides](#styleguides)
+- [Commit Messages](#commit-messages)
+- [Join The Project Team](#join-the-project-team) -->
+
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the
+[SBC API Gateway Code of Conduct](https://github.com/bcgov/sbc-apigw/tree/main/web/site/CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code. Please report unacceptable behavior
+to <>. Add contact?
+
+
+## I Have a Question
+
+> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/bcgov/sbc-apigw/tree/main/web/site/docs/README.md).
+
+Before you ask a question, it is best to search for existing [Issues](https://github.com/bcgov/sbc-apigw/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- Open an [Issue](https://github.com/bcgov/sbc-apigw/issues/new).
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
+
+We will then take care of the issue as soon as possible.
+
+## I Want To Contribute
+
+### How to Contribute
+
+Government employees, public and members of the private sector are encouraged to contribute to the repository by **forking and submitting a pull request**.
+
+(If you are new to GitHub, you might start with a [basic tutorial](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git) and check out a more detailed guide to [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).)
+
+Pull requests will be evaluated by the repository guardians on a schedule and if deemed beneficial will be committed to the master.
+
+All contributors retain the original copyright to their stuff, but by contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users **under the terms of the license under which this project is distributed**.
+
+### Code Owners
+
+As a [code owner](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners), you play a crucial role in maintaining the quality and structure of your designated section within the project. Each code owner is responsible for adding and updating documentation within their specific subdirectory. Your contributions include:
+
+- **Adding Documentation:** Create and update documentation files within your assigned subdirectory to ensure comprehensive coverage of your code areas.
+- **Maintaining Standards:** Ensure that all documentation adheres to the project's style and formatting guidelines.
+- **Reviewing Contributions:** Review and provide feedback on documentation contributions related to your code areas to maintain accuracy and consistency.
+
+Your commitment help us ensure that our documentation remains detailed, accurate, and user-friendly. For detailed guidelines on adding and styling documentation, please refer to our [Documentation](https://github.com/bcgov/sbc-apigw/tree/main/web/site/docs/README.md). Thank you for your contributions!
+
+### Reporting Bugs
+
+<!-- omit in toc -->
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest version.
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/bcgov/sbc-apigw/tree/main/web/site/docs/README.md). If you are looking for support, you might want to check [this section](#i-have-a-question)).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/bcgov/sbc-apigwissues?q=label%3Abug).
+- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
+- Collect information about the bug:
+- Stack trace (Traceback)
+- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
+- Possibly your input and the output
+- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+<!-- omit in toc -->
+#### How Do I Submit a Good Bug Report?
+
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>. ADD CONTACT?
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](https://github.com/bcgov/sbc-apigw/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- The project team will label the issue accordingly.
+- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
+- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for SBC API Gateway, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
+
+<!-- omit in toc -->
+#### Before Submitting an Enhancement
+
+- Make sure that you are using the latest version.
+- Read the [documentation](https://github.com/bcgov/sbc-apigw/tree/main/web/site/docs/README.md) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Perform a [search](https://github.com/bcgov/sbc-apigw/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
+
+<!-- omit in toc -->
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/bcgov/sbc-apigw/issues).
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
+- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
+- **Explain why this enhancement would be useful** to most SBC API Gateway users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+<!-- TODO
+### Your First Code Contribution
+include Setup of env, IDE and typical getting started instructions?
+
+-->
+
+<!-- TODO
+### Improving The Documentation
+Updating, improving and correcting the documentation
+
+-->
+
+<!-- omit in toc -->
+## Attribution
+This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

web/site/README.md

@@ -1,6 +1,15 @@
-# sbc-apigw
+[![License](https://img.shields.io/badge/License-BSD%203%20Clause-blue.svg)](LICENSE)
 
-## Development & Contributing
+# Service BC API Gateway
+
+## Technology Stack Used
+
+- [Nuxt3](https://nuxt.com/) + Typescript
+- [Nuxt UI](https://ui.nuxt.com/)
+- [Nuxt Content](https://content.nuxt.com/)
+- [Playwright](https://playwright.dev/) Testing
+
+## Development
 
 Create a fork and local copy of this repo. Answer _Y_ to create a local clone.
 ```bash
@@ -18,6 +27,15 @@ Startup the development environment.
 pnpm run dev
 ```
 
+## How to Contribute
+
+If you would like to contribute, please see our [CONTRIBUTING](./CONTRIBUTING.md) guidelines.
+
+See the [Documentation](https://github.com/bcgov/sbc-apigw/tree/main/web/site/docs/README.md) for specific guidelines on writing and styling documentation.
+
+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.
+
 ## Testing
 
 Run Vitest in watch mode for unit tests
@@ -37,4 +55,39 @@ Run Playwright e2e tests in Playwright UI
 ```bash
 pnpm run dev
 pnpm test:e2e:ui
-```
+```
+
+## License
+Copyright © 2024 Province of British Columbia
+
+Licensed under the BSD 3 Clause License, (the "License");
+you may not use this file except in compliance with the License.
+The template for the license can be found here
+   https://opensource.org/license/bsd-3-clause/
+
+Redistribution and use in source and binary forms,
+with or without modification, are permitted provided that the
+following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS”
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

web/site/app/components/Sbc/Docs/ProductCard.vue

@@ -1,5 +1,6 @@
 <script setup lang="ts">
 const localePath = useLocalePath()
+const { locale } = useI18n()
 const props = defineProps<{
   name: string
   description: string
@@ -8,8 +9,22 @@ const props = defineProps<{
   directory: string
 }>()
 
-async function goToProduct () {
-  await navigateTo(localePath(`/products/${props.directory}/overview`))
+// get the first file in the products list of md files
+const { data } = await useAsyncData(`product-card-link-${props.directory}`, () => {
+  return queryContent()
+    .where({ _locale: locale.value, _extension: { $eq: 'md' }, _path: { $contains: `/products/${props.directory}` } })
+    .findOne()
+})
+
+// return the localized link
+const link = computed(() => {
+  if (data.value?._path) {
+    return localePath(data.value._path)
+  }
+})
+
+function goToProduct () {
+  return navigateTo(link.value)
 }
 </script>
 <template>
@@ -20,7 +35,7 @@ async function goToProduct () {
   >
     <div class="relative flex h-[60px] items-center bg-bcGovBlue-350 px-4 py-3.5 font-semibold tracking-wide lg:px-7 dark:border-b dark:border-gray-300/50 dark:bg-bcGovColor-darkGray">
       <a
-        :href="localePath(`/products/${directory}/overview`)"
+        :href="link"
         class="text-white focus:outline-none"
         :class="{ 'w-4/5': badge }"
       >

web/site/app/components/content/ProseA.vue

@@ -37,7 +37,8 @@ function resolvePath () {
   >
     <span class="flex items-center gap-1">
       <slot />
-      <UIcon v-if="target === '_blank'" name="i-mdi-open-in-new" />
+      <UIcon v-if="download" name="i-mdi-tray-arrow-down" />
+      <UIcon v-else-if="target === '_blank'" name="i-mdi-open-in-new" />
     </span>
   </UButton>
 </template>

web/site/app/composables/docPageData.ts

@@ -26,14 +26,14 @@ export function useDocPageData () {
   function createPageHead () {
     if (docPageData.value) {
       if (docPageData.value._dir === 'get-started') {
-        return `Get Started - ${docPageData.value.title}`
+        return `Get Started - ${docPageData.value.title} - Service BC Connect API Gateway`
       } else if (docPageData.value._dir === 'connect') {
-        return `SBC Connect - ${docPageData.value.title}`
+        return `SBC Connect - ${docPageData.value.title} - Service BC Connect API Gateway`
       } else {
-        return `${docPageData.value._dir?.toUpperCase()} - ${docPageData.value.title}`
+        return `${docPageData.value._dir?.toUpperCase()} - ${docPageData.value.title} - Service BC Connect API Gateway`
       }
     } else {
-      return 'Service BC Connect'
+      return 'Service BC Connect API Gateway'
     }
   }
 

web/site/content/en-CA/products/mhr/overview.md

@@ -173,8 +173,8 @@ All API responses represent date-time values in the UTC timezone.
 
 ## Additional Resources
 
-- Download a <a href="mhr/apigw-mhr-demo.postman_collection.json.zip" download="apigw-mhr-demo-postman.json" target="_blank">Demo Postman collection</a> to view at least one example of each API path. Provide your own API key and account Id to submit requests and view the responses.
-- Download and view the <a href="mhr/mhr-api-property-lengths.csv" target="_blank">API specification property lengths</a> by model/schema name. _Note that the definitions are not final_.
+- Download a [Demo Postman Collection](mhr/apigw-mhr-demo.postman_collection.json.zip){download="apigw-mhr-demo-postman.json" target="_blank"} to view at least one example of each API path. Provide your own API key and account Id to submit requests and view the responses.
+- Download and view the [API specification property lengths](mhr/mhr-api-property-lengths.csv){download="mhr-api-property-lengths.csv" target="_blank"} by model/schema name. _Note that the definitions are not final_.
 
 ---