diff --git a/.github/ISSUE_TEMPLATE/api-changes.yml b/.github/ISSUE_TEMPLATE/api-changes.yml index 20b8a5d0..ca45e440 100644 --- a/.github/ISSUE_TEMPLATE/api-changes.yml +++ b/.github/ISSUE_TEMPLATE/api-changes.yml @@ -42,7 +42,8 @@ body: | Medium Priority | https://github.com/KinsonDigital/VelaptorDocs/labels/medium%20priority | | High Priority | https://github.com/KinsonDigital/VelaptorDocs/labels/high%20priority | - > **Note** Removing a version of the API docs can be done by executing the _**Delete API Docs**_ VSCode task. + > **Note** + > Removing a version of the API docs can be done by executing the _**Delete API Docs**_ VSCode task. > Just follow the CLI instructions to remove the version. - type: checkboxes diff --git a/.github/ISSUE_TEMPLATE/guide-api-changes.yml b/.github/ISSUE_TEMPLATE/guide-api-changes.yml new file mode 100644 index 00000000..99837e03 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/guide-api-changes.yml @@ -0,0 +1,61 @@ +name: πŸ“œ/πŸ›‘οΈ Guide & API Documentation Changes +description: Create an issue to add or update the API documentation. +title: "πŸ“œ/πŸ›‘οΈGuide & API Doc Change - " +labels: ['πŸ“œtutorial doc changes', 'πŸ›‘οΈapi doc changes', 'high priority'] +projects: ["KinsonDigital/11"] +body: +- type: checkboxes + attributes: + label: Complete The Item Below + options: + - label: I have added the version to the very end of the issue title. + required: true + - label: I have updated the title without removing the πŸ›‘οΈ and πŸ“œ emoji. + required: true + +- type: textarea + attributes: + label: Acceptance Criteria + placeholder: | + Example: + - [ ] If adding a new version of the API documentation, I have locally executed the documentation processing scripts to generate new API documentation. + - [ ] If adding a new version of the API documentation, I have used the correct [Velaptor version](https://github.com/KinsonDigital/Velaptor/tags). + - [ ] Any documentation changes have been checked for proper spelling and grammar. + description: The items to complete in order to satisfy the Definition of Done. + validations: + required: true + render: markdown + +- type: checkboxes + attributes: + label: ToDo Items + description: Complete the following items before requesting a PR review. + options: + - label: Change type labels added to this issue. Refer to the _**Change Type Labels**_ section below. + - label: Priority label added to this issue. Refer to the _**Priority Type Labels**_ section below. + - label: If more than 5 versions exist after adding the new version, the oldest version is removed. + +- type: textarea + attributes: + label: "Additional Information:" + description: DO NOT CHANGE ANYTHING BELOW!! + value: | + **Priority Type Labels** + | Priority Type | Label | + |---------------------|------------------------------------------------------------------------| + | Low Priority | https://github.com/KinsonDigital/VelaptorDocs/labels/low%20priority | + | Medium Priority | https://github.com/KinsonDigital/VelaptorDocs/labels/medium%20priority | + | High Priority | https://github.com/KinsonDigital/VelaptorDocs/labels/high%20priority | + + > **Note** + > Removing a version of the API docs can be done by executing the _**Delete API Docs**_ VSCode task. + > Just follow the CLI instructions to remove the version. + +- type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/KinsonDigital/.github/blob/master/docs/CODE_OF_CONDUCT.md). + options: + - label: I agree to follow this project's Code of Conduct. + required: true diff --git a/.github/workflows/api-release.yml b/.github/workflows/api-release.yml index eb320a46..b1e93852 100644 --- a/.github/workflows/api-release.yml +++ b/.github/workflows/api-release.yml @@ -37,7 +37,7 @@ jobs: needs: validate_branch runs-on: ubuntu-latest steps: - - name: Checkout Repo + - name: Checkout Repo uses: actions/checkout@v4 - name: Validate Syntax @@ -73,7 +73,7 @@ jobs: group: "pages" cancel-in-progress: true steps: - - name: Checkout Repo + - name: Checkout Repo uses: actions/checkout@v4 with: token: ${{ secrets.CICD_TOKEN }} diff --git a/.github/workflows/prod-release.yml b/.github/workflows/prod-release.yml index f366fb32..1e5b3a4f 100644 --- a/.github/workflows/prod-release.yml +++ b/.github/workflows/prod-release.yml @@ -37,7 +37,7 @@ jobs: group: "pages" cancel-in-progress: true steps: - - name: Checkout Repo + - name: Checkout Repo uses: actions/checkout@v4 with: token: ${{ secrets.CICD_TOKEN }} diff --git a/.github/workflows/update-get-version.yml b/.github/workflows/update-get-version.yml index 2309a1fd..f42b99fc 100644 --- a/.github/workflows/update-get-version.yml +++ b/.github/workflows/update-get-version.yml @@ -21,7 +21,7 @@ jobs: outputs: version: ${{ steps.apply_version_to_site.outputs.version }} steps: - - name: Checkout Repository + - name: Checkout Repository uses: actions/checkout@v4 - name: Setup Deno diff --git a/docs/guides/guides/sounds.mdx b/docs/guides/guides/sounds.mdx index eb416501..8660cd9b 100644 --- a/docs/guides/guides/sounds.mdx +++ b/docs/guides/guides/sounds.mdx @@ -90,7 +90,7 @@ You can provide whatever audio file you want, but if you don't have one, you can sound [here](https://github.com/KinsonDigital/VelaptorTutorials/raw/master/Sounds/Content/Sounds/deep-consistency.ogg). Play it to see if you like it. πŸ˜€ -