From 52c9b292cc67c2d2ccee848963be9dd307f58c6e Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Mon, 24 Jun 2024 16:05:46 -0700 Subject: [PATCH 01/34] docs: updated README --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 450c181..83d09eb 100644 --- a/README.md +++ b/README.md @@ -25,17 +25,18 @@ Use the following steps to use the Spectro Cloud Vale package in your documentat MinAlertLevel = suggestion - Packages = https://github.com/spectrocloud/spectro-vale-pkg/releases/latest/download/spectrocloud-docs.zip + Packages = https://github.com/spectrocloud/spectro-vale-pkg/releases/latest/download/spectrocloud.zip Vocab = spectrocloud-vocab [*.md] - BasedOnStyles = Vale, spectrocloud-docs + BasedOnStyles = Vale, spectrocloud ``` -3. In the repository `.gitignore` file, add the following line to ignore the Vale package files: +3. In the repository `.gitignore` file, add the following line to ignore the Vale package files from being committed to the repository: ```shell - vale/styles/spectrocloud-docs/ + .vale-config/ + vale/styles/spectrocloud/ vale/styles/config/vocabularies/spectrocloud-vocab ``` @@ -52,7 +53,7 @@ Use the following steps to use the Spectro Cloud Vale package in your documentat on: pull_request: - types: [opened, synchronize, reopened, ready_for_review] + types: [opened, synchronize, reopened, ready_for_review] concurrency: group: vale-${{ github.ref }} From 65193f4ff085bdb3ff1d349d7cfac39d67900c4a Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Mon, 24 Jun 2024 17:52:39 -0700 Subject: [PATCH 02/34] test: added test suit --- .../tests/ableism/.vale.ini | 4 + .../tests/ableism/fail.md | 9 ++ .../tests/ableism/pass.md | 9 ++ packages/spectrocloud/tests/ableism/.vale.ini | 4 + packages/spectrocloud/tests/ableism/fail.md | 9 ++ packages/spectrocloud/tests/ableism/pass.md | 9 ++ scripts/check_rule.sh | 129 ++++++++++++++++++ scripts/create_zip.sh | 10 ++ 8 files changed, 183 insertions(+) create mode 100644 packages/spectrocloud-docs-internal/tests/ableism/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/ableism/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/ableism/pass.md create mode 100644 packages/spectrocloud/tests/ableism/.vale.ini create mode 100644 packages/spectrocloud/tests/ableism/fail.md create mode 100644 packages/spectrocloud/tests/ableism/pass.md create mode 100755 scripts/check_rule.sh diff --git a/packages/spectrocloud-docs-internal/tests/ableism/.vale.ini b/packages/spectrocloud-docs-internal/tests/ableism/.vale.ini new file mode 100644 index 0000000..4edb2e1 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/ableism/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Ableism = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/ableism/fail.md b/packages/spectrocloud-docs-internal/tests/ableism/fail.md new file mode 100644 index 0000000..006dfc5 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/ableism/fail.md @@ -0,0 +1,9 @@ +## Instructions + +You can access the cluster by running the following command. + +```bash +kubectl get pods +``` + +You can see all the pods that are running in the cluster. diff --git a/packages/spectrocloud-docs-internal/tests/ableism/pass.md b/packages/spectrocloud-docs-internal/tests/ableism/pass.md new file mode 100644 index 0000000..cee6b73 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/ableism/pass.md @@ -0,0 +1,9 @@ +## Instructions + +You can access the cluster by issuing the following command. + +```bash +kubectl get pods +``` + +The output displays all the pods active in the cluster. diff --git a/packages/spectrocloud/tests/ableism/.vale.ini b/packages/spectrocloud/tests/ableism/.vale.ini new file mode 100644 index 0000000..dff6faf --- /dev/null +++ b/packages/spectrocloud/tests/ableism/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Ableism = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/ableism/fail.md b/packages/spectrocloud/tests/ableism/fail.md new file mode 100644 index 0000000..006dfc5 --- /dev/null +++ b/packages/spectrocloud/tests/ableism/fail.md @@ -0,0 +1,9 @@ +## Instructions + +You can access the cluster by running the following command. + +```bash +kubectl get pods +``` + +You can see all the pods that are running in the cluster. diff --git a/packages/spectrocloud/tests/ableism/pass.md b/packages/spectrocloud/tests/ableism/pass.md new file mode 100644 index 0000000..cee6b73 --- /dev/null +++ b/packages/spectrocloud/tests/ableism/pass.md @@ -0,0 +1,9 @@ +## Instructions + +You can access the cluster by issuing the following command. + +```bash +kubectl get pods +``` + +The output displays all the pods active in the cluster. diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh new file mode 100755 index 0000000..3c86323 --- /dev/null +++ b/scripts/check_rule.sh @@ -0,0 +1,129 @@ +#!/bin/sh +# Copyright (c) Spectro Cloud +# SPDX-License-Identifier: Apache-2.0 + +set -e + + +failed_tests=0 + +# Function to get the last directory name from a given path. This is used to get the rule name. +get_last_directory_name() { + dir_path=$1 + base_name=$(basename "$dir_path") + capitalized_name="$(tr '[:lower:]' '[:upper:]' <<< ${base_name:0:1})${base_name:1}" + echo "$capitalized_name" +} + +# This function extracts the first folder name (package name) from a given path. +get_package_name() { + dir_path=$1 + package_name=$(basename "$(dirname "$(dirname "$dir_path")")") + echo "$package_name" +} + + +# This function checks the pass conditions for the Vale rule. A file with the name pass.md is expected to be present. +# The function takes one argument which is the base directory +# The expected folder structure is base_directory/.vale.ini and base_directory/pass.md +# If any error is found, the function will exit with status code 1 +check_pass_conditions() { + base_directory=$1 + config_file="$base_directory/.vale.ini" + pass_md_file="$base_directory/pass.md" + rule_name=$(get_last_directory_name "$base_directory") + package_name=$(get_package_name "$base_directory") + + # Check if the directory contains a file named pass.md + if [ ! -f "$pass_md_file" ]; then + echo "Error: $base_directory does not contain a file named pass.md" + exit 1 + fi + + # Check if the .vale.ini configuration file exists + if [ ! -f "$config_file" ]; then + echo "Error: $base_directory does not contain a file named .vale.ini" + exit 1 + fi + + RESULT=$(vale --config="$config_file" --no-exit --output=line "$pass_md_file" | wc -l) + + if [ "$RESULT" -ne 0 ]; then + echo "$package_name/$rule_name fail condition test - ❌" + failed_tests=$((failed_tests + 1)) + return 1 + fi + + echo "$package_name/$rule_name passs condition test - ✅" +} + +# This function checks the fail conditions for the Vale rule. A file with the name fail.md is expected to be present. +# The function takes one argument which is the base directory +# The expected folder structure is base_directory/.vale.ini and base_directory/fail.md +# If any error is found, the function will exit with status code 1 +check_fail_conditions() { + base_directory=$1 + config_file="$base_directory/.vale.ini" + fail_md_file="$base_directory/fail.md" + rule_name=$(get_last_directory_name "$base_directory") + package_name=$(get_package_name "$base_directory") + + # Check if the directory contains a file named fail.md + if [ ! -f "$fail_md_file" ]; then + echo "Error: $base_directory does not contain a file named pass.md" + exit 1 + fi + + # Check if the .vale.ini configuration file exists + if [ ! -f "$config_file" ]; then + echo "Error: $base_directory does not contain a file named .vale.ini" + exit 1 + fi + + + RESULT=$(vale --config="$config_file" --no-exit --output=line "$fail_md_file" | wc -l) + + if [ "$RESULT" -eq 0 ]; then + echo "$package_name/$rule_name fail condition test - ❌" + failed_tests=$((failed_tests + 1)) + return 1 + fi + echo "$package_name/$rule_name fail condition test - ✅" +} + + +# This function traverses the base directory and checks the pass and fail conditions for the Vale rules. +traverse_and_check() { + base_directory=$1 + + # Traverse the packages directory and look one level down + for package_dir in "$base_directory"/*; do + if [ -d "$package_dir/tests" ]; then + + # Walk the tests directory for sub-directories + echo "" + for test_subdir in "$package_dir/tests"/*; do + if [ -d "$test_subdir" ]; then + check_pass_conditions "$test_subdir" || true + check_fail_conditions "$test_subdir" || true + fi + done + fi + done +} + +# Define the base directory to check (example usage) +BASE_DIRECTORY=$1 +echo "Starting the Vale rule test suit ..." +echo "" +traverse_and_check "$BASE_DIRECTORY" + + +# Output the final number of failed tests +if [ "$failed_tests" -ne 0 ]; then + echo "" + echo "❌ Total failed tests: $failed_tests " +else + echo "" + echo "All Vale rules checked successfully without any errors 🎉" +fi \ No newline at end of file diff --git a/scripts/create_zip.sh b/scripts/create_zip.sh index 094ab99..e9b3114 100755 --- a/scripts/create_zip.sh +++ b/scripts/create_zip.sh @@ -19,9 +19,11 @@ copy_content() { if [ "$1" = "spectrocloud" ]; then echo "Copying content for spectrocloud pkg" cp -R packages/spectrocloud/ workbench/spectrocloud + remove_tests "workbench/spectrocloud" elif [ "$1" = "spectrocloud-docs-internal" ]; then echo "Copying content for spectrocloud-docs-internal pkg" cp -R packages/spectrocloud-docs-internal workbench/spectrocloud-docs-internal + remove_tests "workbench/spectrocloud-docs-internal" fi } @@ -47,6 +49,14 @@ zip_files() { cd .. } +# Function to remove all tests folders from the target directory +# The function takes one argument which is the target directory +remove_tests() { + target_dir=$1 + echo "Removing the tests folder from $target_dir" + find "$target_dir" -type d -name tests -exec rm -rf {} + +} + # Function to check and remove existing zip files # The function takes one argument. Allowed values are "spectrocloud" and "spectrocloud-docs-internal" # The function removes the existing zip files if present From e7948f37f5b6c7f922c0f7ae2802901987c5ff4d Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Mon, 24 Jun 2024 17:54:04 -0700 Subject: [PATCH 03/34] chore: fixed error condition --- scripts/check_rule.sh | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index 3c86323..569fa32 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -123,7 +123,9 @@ traverse_and_check "$BASE_DIRECTORY" if [ "$failed_tests" -ne 0 ]; then echo "" echo "❌ Total failed tests: $failed_tests " -else - echo "" - echo "All Vale rules checked successfully without any errors 🎉" -fi \ No newline at end of file + exit 1 +fi + +echo "" +echo "All Vale rules checked successfully without any errors 🎉" +exit 0 From fe560a6eb327dba12c66124cbe1711a8b513d55f Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 25 Jun 2024 10:22:51 -0700 Subject: [PATCH 04/34] ci: added require files check --- .github/workflows/pull_request.yml | 39 +++++++++ Makefile | 15 +++- .../tests/gender/.vale.ini | 4 + .../tests/gender/fail.md | 9 +++ .../tests/gender/pass.md | 9 +++ packages/spectrocloud/tests/gender/.vale.ini | 4 + packages/spectrocloud/tests/gender/fail.md | 9 +++ packages/spectrocloud/tests/gender/pass.md | 9 +++ scripts/missing_tests.sh | 79 +++++++++++++++++++ 9 files changed, 176 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/pull_request.yml create mode 100644 packages/spectrocloud-docs-internal/tests/gender/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/gender/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/gender/pass.md create mode 100644 packages/spectrocloud/tests/gender/.vale.ini create mode 100644 packages/spectrocloud/tests/gender/fail.md create mode 100644 packages/spectrocloud/tests/gender/pass.md create mode 100755 scripts/missing_tests.sh diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml new file mode 100644 index 0000000..6d21351 --- /dev/null +++ b/.github/workflows/pull_request.yml @@ -0,0 +1,39 @@ +name: Pull Requests + +on: + pull_request: + types: [opened, synchronize, reopened, ready_for_review] + +concurrency: + group: pr-${{ github.ref }} + cancel-in-progress: true + +jobs: + run-ci: + # runs-on: ubuntu-latest + runs-on: ubuntu-latest + defaults: + run: + shell: bash + if: ${{ !github.event.pull_request.draft && github.actor != 'dependabot[bot]' && github.actor != 'dependabot-preview[bot]' }} + steps: + # If the condition above is not met, aka, the PR is not in draft status, then this step is skipped. + # Because this step is part of the critical path, omission of this step will result in remaining CI steps not gettinge executed. + # As of 8/8/2022 there is now way to enforce this beahvior in GitHub Actions CI. + - run: exit 0 + + requirements: + runs-on: ubuntu-latest + needs: run-ci + defaults: + run: + shell: bash + steps: + - name: Checkout Repository + uses: actions/checkout@v4 + + - name: Test Files Present? + run: make required_files + + - name: Tests + run: make tests diff --git a/Makefile b/Makefile index df72180..2a5955d 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,8 @@ .PHONY: license +##@ Development + help: ## Display this help @awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[0m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) @@ -9,7 +11,18 @@ init: ## Initialize the project npm ci -##@ Development +##@ Testing + +required_files: ## Check if required files are present + @echo "Checking if required files are present..." + ./scripts/missing_tests.sh packages/ + + +tests: ## Run tests + @echo "Running tests..." + ./scripts/check_rule.sh packages/ + +##@ Publish zip: ## Create the spectrocloud package ./scripts/create_zip.sh diff --git a/packages/spectrocloud-docs-internal/tests/gender/.vale.ini b/packages/spectrocloud-docs-internal/tests/gender/.vale.ini new file mode 100644 index 0000000..a81f480 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/gender/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Gender = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/gender/fail.md b/packages/spectrocloud-docs-internal/tests/gender/fail.md new file mode 100644 index 0000000..b46eac4 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/gender/fail.md @@ -0,0 +1,9 @@ +## Requirements + +- Ensure users can select the platform version. They may have to request a new version if it is not available. + +- Kubernetes version 1.20.0 or later is required. + +## Usage + +Select the left **Main Menu**. The user, he should ensure there are no errors in the **Platform Version** field. diff --git a/packages/spectrocloud-docs-internal/tests/gender/pass.md b/packages/spectrocloud-docs-internal/tests/gender/pass.md new file mode 100644 index 0000000..08e6b5b --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/gender/pass.md @@ -0,0 +1,9 @@ +## Requirements + +- Ensure users can select the platform version. They may have to request a new version if it is not available. + +- Kubernetes version 1.20.0 or later is required. + +## Usage + +Select the left **Main Menu**. The user should ensure there are no errors in the **Platform Version** field. diff --git a/packages/spectrocloud/tests/gender/.vale.ini b/packages/spectrocloud/tests/gender/.vale.ini new file mode 100644 index 0000000..0efb3a3 --- /dev/null +++ b/packages/spectrocloud/tests/gender/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Gender = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/gender/fail.md b/packages/spectrocloud/tests/gender/fail.md new file mode 100644 index 0000000..b46eac4 --- /dev/null +++ b/packages/spectrocloud/tests/gender/fail.md @@ -0,0 +1,9 @@ +## Requirements + +- Ensure users can select the platform version. They may have to request a new version if it is not available. + +- Kubernetes version 1.20.0 or later is required. + +## Usage + +Select the left **Main Menu**. The user, he should ensure there are no errors in the **Platform Version** field. diff --git a/packages/spectrocloud/tests/gender/pass.md b/packages/spectrocloud/tests/gender/pass.md new file mode 100644 index 0000000..08e6b5b --- /dev/null +++ b/packages/spectrocloud/tests/gender/pass.md @@ -0,0 +1,9 @@ +## Requirements + +- Ensure users can select the platform version. They may have to request a new version if it is not available. + +- Kubernetes version 1.20.0 or later is required. + +## Usage + +Select the left **Main Menu**. The user should ensure there are no errors in the **Platform Version** field. diff --git a/scripts/missing_tests.sh b/scripts/missing_tests.sh new file mode 100755 index 0000000..ed9c9a2 --- /dev/null +++ b/scripts/missing_tests.sh @@ -0,0 +1,79 @@ +#!/bin/bash + +# Base directory (change as needed) +BASE_DIR=$1 + +# Required test files +REQUIRED_FILES=(".vale.ini" "pass.md" "fail.md") + +# Counter for failed tests +failed_tests=0 + +# Function to get the rule name from the rule file path +get_rule_name() { + local rule_file="$1" + local rule_name=$(basename "$rule_file" .yml) + rule_name=${rule_name%.yaml} + echo "$rule_name" +} + +# Function to check if test files exist +check_test_files() { + local test_dir="$1" + local package_name="$2" + local rule_name="$3" + local all_files_exist=true + local missing_files=() + + for file in "${REQUIRED_FILES[@]}"; do + if [[ ! -f "$test_dir/$file" ]]; then + all_files_exist=false + missing_files+=("$file") + fi + done + + if [[ "$all_files_exist" == false ]]; then + ((failed_tests++)) + echo "$package_name/$rule_name missing required files:" + for file in "${missing_files[@]}"; do + echo " - $file" + done + fi + +} + +# Function to traverse the directory structure +traverse_directories() { + for package_dir in "$BASE_DIR"/*; do + echo "" + if [[ -d "$package_dir/styles" ]]; then + local package_name=$(basename "$package_dir") + for rule_file in "$package_dir/styles"/*/*.yml "$package_dir/styles"/*/*.yaml; do + if [[ -f "$rule_file" ]]; then + local rule_name=$(get_rule_name "$rule_file") + local test_dir="$package_dir/tests/$rule_name" + local result="" + if [[ -d "$test_dir" ]]; then + check_test_files "$test_dir" "$package_name" "$rule_name" + else + echo "$package_name/$rule_name missing test directory - ❌" + ((failed_tests++)) + fi + fi + done + fi + done +} + +# Execute the traversal function +traverse_directories "$BASE_DIR" +echo "" + +# Exit with the appropriate status code +if [[ "$failed_tests" -ne 0 ]]; then + echo "❌ Total rules missing tests: $failed_tests " + exit 1 +fi + +echo "All Vale rules have a set of test files 🎉" +exit 0 From 13a91843b15bd1016657f5f7b1fe32fc754d993b Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 25 Jun 2024 12:53:43 -0700 Subject: [PATCH 05/34] test: added more tests --- .../spectrocloud-docs-internal/acronym.yml | 11 +++++------ .../tests/acronym/.vale.ini | 4 ++++ .../tests/acronym/fail.md | 13 +++++++++++++ .../tests/acronym/pass.md | 13 +++++++++++++ .../styles/spectrocloud/acronym.yml | 11 +++++------ .../styles/spectrocloud/admonitions.yml | 3 ++- packages/spectrocloud/tests/acronym/.vale.ini | 4 ++++ packages/spectrocloud/tests/acronym/fail.md | 13 +++++++++++++ packages/spectrocloud/tests/acronym/pass.md | 13 +++++++++++++ .../spectrocloud/tests/admonitions/.vale.ini | 4 ++++ packages/spectrocloud/tests/admonitions/fail.md | 17 +++++++++++++++++ packages/spectrocloud/tests/admonitions/pass.md | 17 +++++++++++++++++ scripts/check_rule.sh | 7 +++++-- scripts/missing_tests.sh | 2 +- 14 files changed, 116 insertions(+), 16 deletions(-) create mode 100644 packages/spectrocloud-docs-internal/tests/acronym/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/acronym/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/acronym/pass.md create mode 100644 packages/spectrocloud/tests/acronym/.vale.ini create mode 100644 packages/spectrocloud/tests/acronym/fail.md create mode 100644 packages/spectrocloud/tests/acronym/pass.md create mode 100644 packages/spectrocloud/tests/admonitions/.vale.ini create mode 100644 packages/spectrocloud/tests/admonitions/fail.md create mode 100644 packages/spectrocloud/tests/admonitions/pass.md diff --git a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/acronym.yml b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/acronym.yml index e53bac2..38335b2 100644 --- a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/acronym.yml +++ b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/acronym.yml @@ -3,14 +3,14 @@ extends: conditional message: "Use title case to define the acronym '%s'." -link: 'https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Acronyms' +link: "https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Acronyms" level: error ignorecase: false scope: text -# Match two to five capital letters surrounded by brackets +# Match two to five capital letters surrounded by brackets # to detect an acronym definition. -first: '[(][A-Z]{2,5}[)]' -# Match two to five capitalised words separated by any number of dashes +first: "[(][A-Z]{2,5}[)]" +# Match two to five capitalised words separated by any number of dashes # or whitespaces before the acronym definition. second: '(\b(([A-Z][a-z]+)[\-\s ]{1,}){2,5})([(][A-Z]{2,5}[)])' exceptions: @@ -35,7 +35,6 @@ exceptions: - (JPEG) - (JPG) - (JSON) - - (OS) - (OSS) - (PDF) - (PNG) @@ -56,4 +55,4 @@ exceptions: - (XML) - (ZIP) - (PXK) - - (PXK-E) \ No newline at end of file + - (PXK-E) diff --git a/packages/spectrocloud-docs-internal/tests/acronym/.vale.ini b/packages/spectrocloud-docs-internal/tests/acronym/.vale.ini new file mode 100644 index 0000000..1bdadb0 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/acronym/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Acronym = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/acronym/fail.md b/packages/spectrocloud-docs-internal/tests/acronym/fail.md new file mode 100644 index 0000000..e0c99db --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/acronym/fail.md @@ -0,0 +1,13 @@ +## Troubleshooting + +Use the following steps to resolve the operating system (OS) error. + +1. Log in to the system console of the OS. + +2. Download the API log from the Logs tab. + + :::info + + You can downlog the log in HTML or JSON format. + + ::: diff --git a/packages/spectrocloud-docs-internal/tests/acronym/pass.md b/packages/spectrocloud-docs-internal/tests/acronym/pass.md new file mode 100644 index 0000000..618489d --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/acronym/pass.md @@ -0,0 +1,13 @@ +## Troubleshooting + +Use the following steps to resolve the Operating System (OS) error. + +1. Log in to the system console of the OS. + +2. Download the API log from the Logs tab. + + :::note + + You can downlog the log in HTML or JSON format. + + ::: diff --git a/packages/spectrocloud/styles/spectrocloud/acronym.yml b/packages/spectrocloud/styles/spectrocloud/acronym.yml index e53bac2..38335b2 100644 --- a/packages/spectrocloud/styles/spectrocloud/acronym.yml +++ b/packages/spectrocloud/styles/spectrocloud/acronym.yml @@ -3,14 +3,14 @@ extends: conditional message: "Use title case to define the acronym '%s'." -link: 'https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Acronyms' +link: "https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Acronyms" level: error ignorecase: false scope: text -# Match two to five capital letters surrounded by brackets +# Match two to five capital letters surrounded by brackets # to detect an acronym definition. -first: '[(][A-Z]{2,5}[)]' -# Match two to five capitalised words separated by any number of dashes +first: "[(][A-Z]{2,5}[)]" +# Match two to five capitalised words separated by any number of dashes # or whitespaces before the acronym definition. second: '(\b(([A-Z][a-z]+)[\-\s ]{1,}){2,5})([(][A-Z]{2,5}[)])' exceptions: @@ -35,7 +35,6 @@ exceptions: - (JPEG) - (JPG) - (JSON) - - (OS) - (OSS) - (PDF) - (PNG) @@ -56,4 +55,4 @@ exceptions: - (XML) - (ZIP) - (PXK) - - (PXK-E) \ No newline at end of file + - (PXK-E) diff --git a/packages/spectrocloud/styles/spectrocloud/admonitions.yml b/packages/spectrocloud/styles/spectrocloud/admonitions.yml index a634a65..c3184e1 100644 --- a/packages/spectrocloud/styles/spectrocloud/admonitions.yml +++ b/packages/spectrocloud/styles/spectrocloud/admonitions.yml @@ -6,6 +6,7 @@ message: "The ':::note' admonition is not approved under the Spectro Cloud style link: https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Admonitions/Callouts level: error nonword: true +scope: raw ignorecase: true swap: - ":::note": ":::info" \ No newline at end of file + ":::note": ":::info" diff --git a/packages/spectrocloud/tests/acronym/.vale.ini b/packages/spectrocloud/tests/acronym/.vale.ini new file mode 100644 index 0000000..c59f5bf --- /dev/null +++ b/packages/spectrocloud/tests/acronym/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Acronym = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/acronym/fail.md b/packages/spectrocloud/tests/acronym/fail.md new file mode 100644 index 0000000..e0c99db --- /dev/null +++ b/packages/spectrocloud/tests/acronym/fail.md @@ -0,0 +1,13 @@ +## Troubleshooting + +Use the following steps to resolve the operating system (OS) error. + +1. Log in to the system console of the OS. + +2. Download the API log from the Logs tab. + + :::info + + You can downlog the log in HTML or JSON format. + + ::: diff --git a/packages/spectrocloud/tests/acronym/pass.md b/packages/spectrocloud/tests/acronym/pass.md new file mode 100644 index 0000000..0166712 --- /dev/null +++ b/packages/spectrocloud/tests/acronym/pass.md @@ -0,0 +1,13 @@ +## Troubleshooting + +Use the following steps to resolve the Operating System (OS) error. + +1. Log in to the system console of the OS. + +2. Download the API log from the Logs tab. + + :::info + + You can downlog the log in HTML or JSON format. + + ::: diff --git a/packages/spectrocloud/tests/admonitions/.vale.ini b/packages/spectrocloud/tests/admonitions/.vale.ini new file mode 100644 index 0000000..3109df8 --- /dev/null +++ b/packages/spectrocloud/tests/admonitions/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Admonitions = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/admonitions/fail.md b/packages/spectrocloud/tests/admonitions/fail.md new file mode 100644 index 0000000..537e0e6 --- /dev/null +++ b/packages/spectrocloud/tests/admonitions/fail.md @@ -0,0 +1,17 @@ +# Learn to Use Palette + +In this tutorial, you will learn how to use Palette to deploy a Kubernetes cluster. + + :::note + + This tutorial does not cover Edge clusters. + + ::: + +The following table lists the supported operating systems for the Palette platform. + +:::note + +This will trigger a failure. + +::: diff --git a/packages/spectrocloud/tests/admonitions/pass.md b/packages/spectrocloud/tests/admonitions/pass.md new file mode 100644 index 0000000..584ccb7 --- /dev/null +++ b/packages/spectrocloud/tests/admonitions/pass.md @@ -0,0 +1,17 @@ +# Learn to Use Palette + +In this tutorial, you will learn how to use Palette to deploy a Kubernetes cluster. + + :::info + + This tutorial does not cover Edge clusters. + + ::: + +The following table lists the supported operating systems for the Palette platform. + +:::info + +This will not trigger a failure. + +::: diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index 569fa32..344090d 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -48,13 +48,16 @@ check_pass_conditions() { RESULT=$(vale --config="$config_file" --no-exit --output=line "$pass_md_file" | wc -l) + if [ "$RESULT" -ne 0 ]; then echo "$package_name/$rule_name fail condition test - ❌" + log=$(vale --config="$config_file" --output=line "$pass_md_file") + echo "Debug: $log" failed_tests=$((failed_tests + 1)) return 1 fi - echo "$package_name/$rule_name passs condition test - ✅" + echo "$package_name/$rule_name pass condition test - ✅" } # This function checks the fail conditions for the Vale rule. A file with the name fail.md is expected to be present. @@ -84,7 +87,7 @@ check_fail_conditions() { RESULT=$(vale --config="$config_file" --no-exit --output=line "$fail_md_file" | wc -l) if [ "$RESULT" -eq 0 ]; then - echo "$package_name/$rule_name fail condition test - ❌" + echo "$package_name/$rule_name fail condition test - ❌" failed_tests=$((failed_tests + 1)) return 1 fi diff --git a/scripts/missing_tests.sh b/scripts/missing_tests.sh index ed9c9a2..2629cf4 100755 --- a/scripts/missing_tests.sh +++ b/scripts/missing_tests.sh @@ -34,7 +34,7 @@ check_test_files() { if [[ "$all_files_exist" == false ]]; then ((failed_tests++)) - echo "$package_name/$rule_name missing required files:" + echo "$package_name/$rule_name missing required files: ❌" for file in "${missing_files[@]}"; do echo " - $file" done From f353688a069b09f09287f7e0b82b2624f9787165 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 25 Jun 2024 13:08:30 -0700 Subject: [PATCH 06/34] test: added more tests --- .../tests/admonitions/.vale.ini | 4 ++++ .../tests/admonitions/fail.md | 17 +++++++++++++++ .../tests/admonitions/pass.md | 17 +++++++++++++++ .../tests/colon/.vale.ini | 4 ++++ .../tests/colon/fail.md | 21 +++++++++++++++++++ .../tests/colon/pass.md | 21 +++++++++++++++++++ .../tests/condescending/.vale.ini | 4 ++++ .../tests/condescending/fail.md | 8 +++++++ .../tests/condescending/pass.md | 7 +++++++ .../tests/direction/.vale.ini | 4 ++++ .../tests/direction/fail.md | 9 ++++++++ .../tests/direction/pass.md | 9 ++++++++ packages/spectrocloud/tests/colon/.vale.ini | 4 ++++ packages/spectrocloud/tests/colon/fail.md | 21 +++++++++++++++++++ packages/spectrocloud/tests/colon/pass.md | 21 +++++++++++++++++++ .../tests/condescending/.vale.ini | 4 ++++ .../spectrocloud/tests/condescending/fail.md | 8 +++++++ .../spectrocloud/tests/condescending/pass.md | 7 +++++++ .../spectrocloud/tests/direction/.vale.ini | 4 ++++ packages/spectrocloud/tests/direction/fail.md | 9 ++++++++ packages/spectrocloud/tests/direction/pass.md | 9 ++++++++ 21 files changed, 212 insertions(+) create mode 100644 packages/spectrocloud-docs-internal/tests/admonitions/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/admonitions/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/admonitions/pass.md create mode 100644 packages/spectrocloud-docs-internal/tests/colon/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/colon/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/colon/pass.md create mode 100644 packages/spectrocloud-docs-internal/tests/condescending/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/condescending/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/condescending/pass.md create mode 100644 packages/spectrocloud-docs-internal/tests/direction/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/direction/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/direction/pass.md create mode 100644 packages/spectrocloud/tests/colon/.vale.ini create mode 100644 packages/spectrocloud/tests/colon/fail.md create mode 100644 packages/spectrocloud/tests/colon/pass.md create mode 100644 packages/spectrocloud/tests/condescending/.vale.ini create mode 100644 packages/spectrocloud/tests/condescending/fail.md create mode 100644 packages/spectrocloud/tests/condescending/pass.md create mode 100644 packages/spectrocloud/tests/direction/.vale.ini create mode 100644 packages/spectrocloud/tests/direction/fail.md create mode 100644 packages/spectrocloud/tests/direction/pass.md diff --git a/packages/spectrocloud-docs-internal/tests/admonitions/.vale.ini b/packages/spectrocloud-docs-internal/tests/admonitions/.vale.ini new file mode 100644 index 0000000..be7d45f --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/admonitions/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Admonitions = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/admonitions/fail.md b/packages/spectrocloud-docs-internal/tests/admonitions/fail.md new file mode 100644 index 0000000..537e0e6 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/admonitions/fail.md @@ -0,0 +1,17 @@ +# Learn to Use Palette + +In this tutorial, you will learn how to use Palette to deploy a Kubernetes cluster. + + :::note + + This tutorial does not cover Edge clusters. + + ::: + +The following table lists the supported operating systems for the Palette platform. + +:::note + +This will trigger a failure. + +::: diff --git a/packages/spectrocloud-docs-internal/tests/admonitions/pass.md b/packages/spectrocloud-docs-internal/tests/admonitions/pass.md new file mode 100644 index 0000000..584ccb7 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/admonitions/pass.md @@ -0,0 +1,17 @@ +# Learn to Use Palette + +In this tutorial, you will learn how to use Palette to deploy a Kubernetes cluster. + + :::info + + This tutorial does not cover Edge clusters. + + ::: + +The following table lists the supported operating systems for the Palette platform. + +:::info + +This will not trigger a failure. + +::: diff --git a/packages/spectrocloud-docs-internal/tests/colon/.vale.ini b/packages/spectrocloud-docs-internal/tests/colon/.vale.ini new file mode 100644 index 0000000..e93f59c --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/colon/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Colon = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/colon/fail.md b/packages/spectrocloud-docs-internal/tests/colon/fail.md new file mode 100644 index 0000000..7f00a04 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/colon/fail.md @@ -0,0 +1,21 @@ +### Deploying Cluster Profile + +Use the following command to remove all previous configurations: + + ```bash + kubectl delete -f cluster-profile.yaml + ``` + + :::info + + This callout is allowed. + + ::: + +A few things to keep in mind before removing the cluster profile: + +- The cluster profile is removed Palette + +- Active clusters are not affected. + +- Names starting with `project:scope` are reserved for internal use. diff --git a/packages/spectrocloud-docs-internal/tests/colon/pass.md b/packages/spectrocloud-docs-internal/tests/colon/pass.md new file mode 100644 index 0000000..c0d07eb --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/colon/pass.md @@ -0,0 +1,21 @@ +### Deploying Cluster Profile + +Use the following command to remove all previous configurations. + + ```bash + kubectl delete -f cluster-profile.yaml + ``` + + :::info + + This callout is allowed. + + ::: + +A few things to keep in mind before removing the cluster profile: + +- The cluster profile is removed Palette + +- Active clusters are not affected. + +- Names starting with `project:scope` are reserved for internal use. diff --git a/packages/spectrocloud-docs-internal/tests/condescending/.vale.ini b/packages/spectrocloud-docs-internal/tests/condescending/.vale.ini new file mode 100644 index 0000000..42c4250 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/condescending/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Condescending = YES diff --git a/packages/spectrocloud-docs-internal/tests/condescending/fail.md b/packages/spectrocloud-docs-internal/tests/condescending/fail.md new file mode 100644 index 0000000..4b2479a --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/condescending/fail.md @@ -0,0 +1,8 @@ +## Information + +The design of the prouct is based on the following principles: + +- Reduce complexity by providing an easy single pane of glass for managing all your clusters. +- Provide a consistent experience across all cloud providers. +- Ease the use of Kubernetes by providing a clear and intuitive user interface. +- Obvious UX patterns and design elements. diff --git a/packages/spectrocloud-docs-internal/tests/condescending/pass.md b/packages/spectrocloud-docs-internal/tests/condescending/pass.md new file mode 100644 index 0000000..0524c7b --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/condescending/pass.md @@ -0,0 +1,7 @@ +## Information + +The design of the prouct is based on the following principles: + +- Reduce complexity by providing a single pane of glass for managing all your clusters. +- Provide a consistent experience across all cloud providers. +- Ease the use of Kubernetes by providing a clear and intuitive user interface. diff --git a/packages/spectrocloud-docs-internal/tests/direction/.vale.ini b/packages/spectrocloud-docs-internal/tests/direction/.vale.ini new file mode 100644 index 0000000..992039b --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/direction/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Direction = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/direction/fail.md b/packages/spectrocloud-docs-internal/tests/direction/fail.md new file mode 100644 index 0000000..579b8ce --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/direction/fail.md @@ -0,0 +1,9 @@ +# Spectro Pack + +The Spectro Pack is used to maintain internal Palette configurations used by the Palette Installer during a deployment. The following list provides an overview of the Spectro Pack: + +- A pack containing immutable configurations used by the Palette Installer. + +- The Spectro Pack is used to maintain internal Palette configurations. + +- As mentioned above, the Spectro Pack is immutable and should not be modified. diff --git a/packages/spectrocloud-docs-internal/tests/direction/pass.md b/packages/spectrocloud-docs-internal/tests/direction/pass.md new file mode 100644 index 0000000..19baee2 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/direction/pass.md @@ -0,0 +1,9 @@ +# Spectro Pack + +The Spectro Pack is used to maintain internal Palette configurations used by the Palette Installer during a deployment. The following list provides an overview of the Spectro Pack: + +- A pack containing immutable configurations used by the Palette Installer. + +- The Spectro Pack is used to maintain internal Palette configurations. + +- As mention earlier, the Spectro Pack is immutable and should not be modified. diff --git a/packages/spectrocloud/tests/colon/.vale.ini b/packages/spectrocloud/tests/colon/.vale.ini new file mode 100644 index 0000000..6e7699a --- /dev/null +++ b/packages/spectrocloud/tests/colon/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Colon = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/colon/fail.md b/packages/spectrocloud/tests/colon/fail.md new file mode 100644 index 0000000..7f00a04 --- /dev/null +++ b/packages/spectrocloud/tests/colon/fail.md @@ -0,0 +1,21 @@ +### Deploying Cluster Profile + +Use the following command to remove all previous configurations: + + ```bash + kubectl delete -f cluster-profile.yaml + ``` + + :::info + + This callout is allowed. + + ::: + +A few things to keep in mind before removing the cluster profile: + +- The cluster profile is removed Palette + +- Active clusters are not affected. + +- Names starting with `project:scope` are reserved for internal use. diff --git a/packages/spectrocloud/tests/colon/pass.md b/packages/spectrocloud/tests/colon/pass.md new file mode 100644 index 0000000..c0d07eb --- /dev/null +++ b/packages/spectrocloud/tests/colon/pass.md @@ -0,0 +1,21 @@ +### Deploying Cluster Profile + +Use the following command to remove all previous configurations. + + ```bash + kubectl delete -f cluster-profile.yaml + ``` + + :::info + + This callout is allowed. + + ::: + +A few things to keep in mind before removing the cluster profile: + +- The cluster profile is removed Palette + +- Active clusters are not affected. + +- Names starting with `project:scope` are reserved for internal use. diff --git a/packages/spectrocloud/tests/condescending/.vale.ini b/packages/spectrocloud/tests/condescending/.vale.ini new file mode 100644 index 0000000..79220bb --- /dev/null +++ b/packages/spectrocloud/tests/condescending/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Condescending = YES diff --git a/packages/spectrocloud/tests/condescending/fail.md b/packages/spectrocloud/tests/condescending/fail.md new file mode 100644 index 0000000..4b2479a --- /dev/null +++ b/packages/spectrocloud/tests/condescending/fail.md @@ -0,0 +1,8 @@ +## Information + +The design of the prouct is based on the following principles: + +- Reduce complexity by providing an easy single pane of glass for managing all your clusters. +- Provide a consistent experience across all cloud providers. +- Ease the use of Kubernetes by providing a clear and intuitive user interface. +- Obvious UX patterns and design elements. diff --git a/packages/spectrocloud/tests/condescending/pass.md b/packages/spectrocloud/tests/condescending/pass.md new file mode 100644 index 0000000..0524c7b --- /dev/null +++ b/packages/spectrocloud/tests/condescending/pass.md @@ -0,0 +1,7 @@ +## Information + +The design of the prouct is based on the following principles: + +- Reduce complexity by providing a single pane of glass for managing all your clusters. +- Provide a consistent experience across all cloud providers. +- Ease the use of Kubernetes by providing a clear and intuitive user interface. diff --git a/packages/spectrocloud/tests/direction/.vale.ini b/packages/spectrocloud/tests/direction/.vale.ini new file mode 100644 index 0000000..38b96ae --- /dev/null +++ b/packages/spectrocloud/tests/direction/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Direction = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/direction/fail.md b/packages/spectrocloud/tests/direction/fail.md new file mode 100644 index 0000000..579b8ce --- /dev/null +++ b/packages/spectrocloud/tests/direction/fail.md @@ -0,0 +1,9 @@ +# Spectro Pack + +The Spectro Pack is used to maintain internal Palette configurations used by the Palette Installer during a deployment. The following list provides an overview of the Spectro Pack: + +- A pack containing immutable configurations used by the Palette Installer. + +- The Spectro Pack is used to maintain internal Palette configurations. + +- As mentioned above, the Spectro Pack is immutable and should not be modified. diff --git a/packages/spectrocloud/tests/direction/pass.md b/packages/spectrocloud/tests/direction/pass.md new file mode 100644 index 0000000..19baee2 --- /dev/null +++ b/packages/spectrocloud/tests/direction/pass.md @@ -0,0 +1,9 @@ +# Spectro Pack + +The Spectro Pack is used to maintain internal Palette configurations used by the Palette Installer during a deployment. The following list provides an overview of the Spectro Pack: + +- A pack containing immutable configurations used by the Palette Installer. + +- The Spectro Pack is used to maintain internal Palette configurations. + +- As mention earlier, the Spectro Pack is immutable and should not be modified. From e86db897256838b5bf3cd661a09cb92053473cef Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 25 Jun 2024 13:36:27 -0700 Subject: [PATCH 07/34] test: added more tests --- .../admonitions.yml | 3 ++- .../spectrocloud-docs-internal/future.yml | 13 +++++++------ .../tests/file-type/.vale.ini | 4 ++++ .../tests/file-type/fail.md | 19 +++++++++++++++++++ .../tests/file-type/pass.md | 19 +++++++++++++++++++ .../tests/future/.vale.ini | 4 ++++ .../tests/future/fail.md | 9 +++++++++ .../tests/future/pass.md | 3 +++ .../styles/spectrocloud/future.yml | 13 +++++++------ .../spectrocloud/tests/file-type/.vale.ini | 4 ++++ packages/spectrocloud/tests/file-type/fail.md | 19 +++++++++++++++++++ packages/spectrocloud/tests/file-type/pass.md | 19 +++++++++++++++++++ packages/spectrocloud/tests/future/.vale.ini | 4 ++++ packages/spectrocloud/tests/future/fail.md | 9 +++++++++ packages/spectrocloud/tests/future/pass.md | 3 +++ 15 files changed, 132 insertions(+), 13 deletions(-) create mode 100644 packages/spectrocloud-docs-internal/tests/file-type/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/file-type/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/file-type/pass.md create mode 100644 packages/spectrocloud-docs-internal/tests/future/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/future/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/future/pass.md create mode 100644 packages/spectrocloud/tests/file-type/.vale.ini create mode 100644 packages/spectrocloud/tests/file-type/fail.md create mode 100644 packages/spectrocloud/tests/file-type/pass.md create mode 100644 packages/spectrocloud/tests/future/.vale.ini create mode 100644 packages/spectrocloud/tests/future/fail.md create mode 100644 packages/spectrocloud/tests/future/pass.md diff --git a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/admonitions.yml b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/admonitions.yml index a634a65..c3184e1 100644 --- a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/admonitions.yml +++ b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/admonitions.yml @@ -6,6 +6,7 @@ message: "The ':::note' admonition is not approved under the Spectro Cloud style link: https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Admonitions/Callouts level: error nonword: true +scope: raw ignorecase: true swap: - ":::note": ":::info" \ No newline at end of file + ":::note": ":::info" diff --git a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/future.yml b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/future.yml index 9c4432d..634dffa 100644 --- a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/future.yml +++ b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/future.yml @@ -6,9 +6,10 @@ message: "Avoid documenting features that are not available at present. You ment level: error ignorecase: true tokens: - - 'coming soon' - - 'in the future' - - 'not yet available' - - 'will be released' - - 'to be implemented' - - 'under development' + - "coming soon" + - "in the future" + - "not yet available" + - "will be released" + - "to be implemented" + - "under development" + - "next release" diff --git a/packages/spectrocloud-docs-internal/tests/file-type/.vale.ini b/packages/spectrocloud-docs-internal/tests/file-type/.vale.ini new file mode 100644 index 0000000..46fa95c --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/file-type/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.File-Type = YES diff --git a/packages/spectrocloud-docs-internal/tests/file-type/fail.md b/packages/spectrocloud-docs-internal/tests/file-type/fail.md new file mode 100644 index 0000000..b8f4d8d --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/file-type/fail.md @@ -0,0 +1,19 @@ +# Supported Formats + +The following file type are supported by Palette: + +- csv file +- iso file +- json file +- md file +- pdf file +- png file +- py file +- svg file +- tar file +- tf file +- tgz file +- txt file +- yaml file +- ZIP file +- zst file diff --git a/packages/spectrocloud-docs-internal/tests/file-type/pass.md b/packages/spectrocloud-docs-internal/tests/file-type/pass.md new file mode 100644 index 0000000..86f2f52 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/file-type/pass.md @@ -0,0 +1,19 @@ +# Supported Formats + +The following file type are supported by Palette: + +- CSV file +- ISO file +- JSON file +- MD file +- PDF file +- PNG file +- PY file +- SVG file +- TAR file +- TF file +- TGZ file +- TXT file +- YAML file +- zip file +- ZST file diff --git a/packages/spectrocloud-docs-internal/tests/future/.vale.ini b/packages/spectrocloud-docs-internal/tests/future/.vale.ini new file mode 100644 index 0000000..327d4fc --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/future/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Future = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/future/fail.md b/packages/spectrocloud-docs-internal/tests/future/fail.md new file mode 100644 index 0000000..2b58789 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/future/fail.md @@ -0,0 +1,9 @@ +# Overview + +In the next release of Palette, the ability to deploy multiple Kubernetes clusters with a single click will be available + +:::info + +This feature will be limited to the Enterprise Edition. VerteX is still under development and will be announced in the future. + +::: diff --git a/packages/spectrocloud-docs-internal/tests/future/pass.md b/packages/spectrocloud-docs-internal/tests/future/pass.md new file mode 100644 index 0000000..8ecc755 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/future/pass.md @@ -0,0 +1,3 @@ +# Overview + +The ability to deploy multiple Kubernetes clusters with a single click is not currently available in Palette. End users can achieve similar functionality by using the Spectro Cloud API to automate the deployment of multiple clusters. diff --git a/packages/spectrocloud/styles/spectrocloud/future.yml b/packages/spectrocloud/styles/spectrocloud/future.yml index 9c4432d..634dffa 100644 --- a/packages/spectrocloud/styles/spectrocloud/future.yml +++ b/packages/spectrocloud/styles/spectrocloud/future.yml @@ -6,9 +6,10 @@ message: "Avoid documenting features that are not available at present. You ment level: error ignorecase: true tokens: - - 'coming soon' - - 'in the future' - - 'not yet available' - - 'will be released' - - 'to be implemented' - - 'under development' + - "coming soon" + - "in the future" + - "not yet available" + - "will be released" + - "to be implemented" + - "under development" + - "next release" diff --git a/packages/spectrocloud/tests/file-type/.vale.ini b/packages/spectrocloud/tests/file-type/.vale.ini new file mode 100644 index 0000000..1a1498c --- /dev/null +++ b/packages/spectrocloud/tests/file-type/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.File-Type = YES diff --git a/packages/spectrocloud/tests/file-type/fail.md b/packages/spectrocloud/tests/file-type/fail.md new file mode 100644 index 0000000..b8f4d8d --- /dev/null +++ b/packages/spectrocloud/tests/file-type/fail.md @@ -0,0 +1,19 @@ +# Supported Formats + +The following file type are supported by Palette: + +- csv file +- iso file +- json file +- md file +- pdf file +- png file +- py file +- svg file +- tar file +- tf file +- tgz file +- txt file +- yaml file +- ZIP file +- zst file diff --git a/packages/spectrocloud/tests/file-type/pass.md b/packages/spectrocloud/tests/file-type/pass.md new file mode 100644 index 0000000..86f2f52 --- /dev/null +++ b/packages/spectrocloud/tests/file-type/pass.md @@ -0,0 +1,19 @@ +# Supported Formats + +The following file type are supported by Palette: + +- CSV file +- ISO file +- JSON file +- MD file +- PDF file +- PNG file +- PY file +- SVG file +- TAR file +- TF file +- TGZ file +- TXT file +- YAML file +- zip file +- ZST file diff --git a/packages/spectrocloud/tests/future/.vale.ini b/packages/spectrocloud/tests/future/.vale.ini new file mode 100644 index 0000000..a7b209e --- /dev/null +++ b/packages/spectrocloud/tests/future/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Future = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/future/fail.md b/packages/spectrocloud/tests/future/fail.md new file mode 100644 index 0000000..2b58789 --- /dev/null +++ b/packages/spectrocloud/tests/future/fail.md @@ -0,0 +1,9 @@ +# Overview + +In the next release of Palette, the ability to deploy multiple Kubernetes clusters with a single click will be available + +:::info + +This feature will be limited to the Enterprise Edition. VerteX is still under development and will be announced in the future. + +::: diff --git a/packages/spectrocloud/tests/future/pass.md b/packages/spectrocloud/tests/future/pass.md new file mode 100644 index 0000000..8ecc755 --- /dev/null +++ b/packages/spectrocloud/tests/future/pass.md @@ -0,0 +1,3 @@ +# Overview + +The ability to deploy multiple Kubernetes clusters with a single click is not currently available in Palette. End users can achieve similar functionality by using the Spectro Cloud API to automate the deployment of multiple clusters. From 8898e11fc89008085fb28e634ddbbd31c0d1fe8e Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 25 Jun 2024 14:10:02 -0700 Subject: [PATCH 08/34] test: more test and minor refactoring --- .../spectrocloud-docs-internal/headings-title.yml | 10 +++------- .../tests/headings-title/.vale.ini | 4 ++++ .../tests/headings-title/fail.md | 11 +++++++++++ .../tests/headings-title/pass.md | 11 +++++++++++ .../styles/spectrocloud/headings-title.yml | 10 +++------- packages/spectrocloud/tests/headings-title/.vale.ini | 4 ++++ packages/spectrocloud/tests/headings-title/fail.md | 11 +++++++++++ packages/spectrocloud/tests/headings-title/pass.md | 11 +++++++++++ 8 files changed, 58 insertions(+), 14 deletions(-) create mode 100644 packages/spectrocloud-docs-internal/tests/headings-title/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/headings-title/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/headings-title/pass.md create mode 100644 packages/spectrocloud/tests/headings-title/.vale.ini create mode 100644 packages/spectrocloud/tests/headings-title/fail.md create mode 100644 packages/spectrocloud/tests/headings-title/pass.md diff --git a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/headings-title.yml b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/headings-title.yml index 7c0e233..81579ad 100644 --- a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/headings-title.yml +++ b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/headings-title.yml @@ -2,12 +2,8 @@ # SPDX-License-Identifier: Apache-2.0 extends: existence -message: "Avoid using a noun that starts with an '-ing' in headings. Your heading starts with '%s'." +message: "Avoid using a noun that starts with an -ing in headings. Your heading starts with a word ending in '%s'." level: error +scope: heading raw: - - '\n\n\# [a-z]*ing ' - - '\n\n\#\# [a-z]*ing ' - - '\n\n\#\#\# [a-z]*ing ' - - '\n\n\#\#\#\# [a-z]*ing ' - - '\n\n\#\#\#\#\# [a-z]*ing ' - - '\n\n\#\#\#\#\#\# [a-z]*ing ' \ No newline at end of file + - "ing\\b" diff --git a/packages/spectrocloud-docs-internal/tests/headings-title/.vale.ini b/packages/spectrocloud-docs-internal/tests/headings-title/.vale.ini new file mode 100644 index 0000000..a86b9da --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/headings-title/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Headings-Title = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/headings-title/fail.md b/packages/spectrocloud-docs-internal/tests/headings-title/fail.md new file mode 100644 index 0000000..6d473de --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/headings-title/fail.md @@ -0,0 +1,11 @@ +# Palette eXtended Kubernetes (PXK) + +Palette eXtended Kubernetes (PXK) is a Kubernetes distribution that is optimized for Palette. + +### Features + +#### Managing Multiple Clusters + +##### Security + +###### Exceptions diff --git a/packages/spectrocloud-docs-internal/tests/headings-title/pass.md b/packages/spectrocloud-docs-internal/tests/headings-title/pass.md new file mode 100644 index 0000000..1737a53 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/headings-title/pass.md @@ -0,0 +1,11 @@ +# Palette eXtended Kubernetes (PXK) + +Palette eXtended Kubernetes (PXK) is a Kubernetes distribution that is optimized for Palette. + +### Features + +#### Multi-Cluster Management + +##### Security + +###### Exceptions diff --git a/packages/spectrocloud/styles/spectrocloud/headings-title.yml b/packages/spectrocloud/styles/spectrocloud/headings-title.yml index 7c0e233..81579ad 100644 --- a/packages/spectrocloud/styles/spectrocloud/headings-title.yml +++ b/packages/spectrocloud/styles/spectrocloud/headings-title.yml @@ -2,12 +2,8 @@ # SPDX-License-Identifier: Apache-2.0 extends: existence -message: "Avoid using a noun that starts with an '-ing' in headings. Your heading starts with '%s'." +message: "Avoid using a noun that starts with an -ing in headings. Your heading starts with a word ending in '%s'." level: error +scope: heading raw: - - '\n\n\# [a-z]*ing ' - - '\n\n\#\# [a-z]*ing ' - - '\n\n\#\#\# [a-z]*ing ' - - '\n\n\#\#\#\# [a-z]*ing ' - - '\n\n\#\#\#\#\# [a-z]*ing ' - - '\n\n\#\#\#\#\#\# [a-z]*ing ' \ No newline at end of file + - "ing\\b" diff --git a/packages/spectrocloud/tests/headings-title/.vale.ini b/packages/spectrocloud/tests/headings-title/.vale.ini new file mode 100644 index 0000000..aa6019c --- /dev/null +++ b/packages/spectrocloud/tests/headings-title/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Headings-Title = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/headings-title/fail.md b/packages/spectrocloud/tests/headings-title/fail.md new file mode 100644 index 0000000..6d473de --- /dev/null +++ b/packages/spectrocloud/tests/headings-title/fail.md @@ -0,0 +1,11 @@ +# Palette eXtended Kubernetes (PXK) + +Palette eXtended Kubernetes (PXK) is a Kubernetes distribution that is optimized for Palette. + +### Features + +#### Managing Multiple Clusters + +##### Security + +###### Exceptions diff --git a/packages/spectrocloud/tests/headings-title/pass.md b/packages/spectrocloud/tests/headings-title/pass.md new file mode 100644 index 0000000..1737a53 --- /dev/null +++ b/packages/spectrocloud/tests/headings-title/pass.md @@ -0,0 +1,11 @@ +# Palette eXtended Kubernetes (PXK) + +Palette eXtended Kubernetes (PXK) is a Kubernetes distribution that is optimized for Palette. + +### Features + +#### Multi-Cluster Management + +##### Security + +###### Exceptions From 030650658147ab6235801b0eb84f4e5bd762bc1d Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 25 Jun 2024 14:37:14 -0700 Subject: [PATCH 09/34] test: added more tests --- .../styles/spectrocloud-docs-internal/inclusive.yml | 9 ++++----- .../spectrocloud-docs-internal/tests/inclusive/.vale.ini | 4 ++++ .../spectrocloud-docs-internal/tests/inclusive/fail.md | 3 +++ .../spectrocloud-docs-internal/tests/inclusive/pass.md | 3 +++ packages/spectrocloud/styles/spectrocloud/inclusive.yml | 9 ++++----- packages/spectrocloud/tests/inclusive/.vale.ini | 4 ++++ packages/spectrocloud/tests/inclusive/fail.md | 3 +++ packages/spectrocloud/tests/inclusive/pass.md | 3 +++ 8 files changed, 28 insertions(+), 10 deletions(-) create mode 100644 packages/spectrocloud-docs-internal/tests/inclusive/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/inclusive/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/inclusive/pass.md create mode 100644 packages/spectrocloud/tests/inclusive/.vale.ini create mode 100644 packages/spectrocloud/tests/inclusive/fail.md create mode 100644 packages/spectrocloud/tests/inclusive/pass.md diff --git a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/inclusive.yml b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/inclusive.yml index e554fb7..836000b 100644 --- a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/inclusive.yml +++ b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/inclusive.yml @@ -6,9 +6,8 @@ message: "Consider avoiding '%s' in favor of more inclusive language." link: "https://spectrocloud.atlassian.net/wiki/x/AQBCaQ" ignorecase: true level: error -tokens: - - master - - slave nonword: true -exceptions: - - master branch \ No newline at end of file +scope: raw +tokens: + - '\b(master)\b(?! branch)' + - '\bslave\b' diff --git a/packages/spectrocloud-docs-internal/tests/inclusive/.vale.ini b/packages/spectrocloud-docs-internal/tests/inclusive/.vale.ini new file mode 100644 index 0000000..7b6d2b9 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/inclusive/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Inclusive = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/inclusive/fail.md b/packages/spectrocloud-docs-internal/tests/inclusive/fail.md new file mode 100644 index 0000000..08cfcc3 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/inclusive/fail.md @@ -0,0 +1,3 @@ +# Cluster Nodes + +Palette manages both the master and worker nodes in a cluster. The master nodes are responsible for managing the worker nodes, and the worker nodes are responsible for handling the workloads. diff --git a/packages/spectrocloud-docs-internal/tests/inclusive/pass.md b/packages/spectrocloud-docs-internal/tests/inclusive/pass.md new file mode 100644 index 0000000..5074902 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/inclusive/pass.md @@ -0,0 +1,3 @@ +# Cluster Nodes + +The source code can be found in the master branch of the public repository. diff --git a/packages/spectrocloud/styles/spectrocloud/inclusive.yml b/packages/spectrocloud/styles/spectrocloud/inclusive.yml index e554fb7..836000b 100644 --- a/packages/spectrocloud/styles/spectrocloud/inclusive.yml +++ b/packages/spectrocloud/styles/spectrocloud/inclusive.yml @@ -6,9 +6,8 @@ message: "Consider avoiding '%s' in favor of more inclusive language." link: "https://spectrocloud.atlassian.net/wiki/x/AQBCaQ" ignorecase: true level: error -tokens: - - master - - slave nonword: true -exceptions: - - master branch \ No newline at end of file +scope: raw +tokens: + - '\b(master)\b(?! branch)' + - '\bslave\b' diff --git a/packages/spectrocloud/tests/inclusive/.vale.ini b/packages/spectrocloud/tests/inclusive/.vale.ini new file mode 100644 index 0000000..5afd805 --- /dev/null +++ b/packages/spectrocloud/tests/inclusive/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Inclusive = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/inclusive/fail.md b/packages/spectrocloud/tests/inclusive/fail.md new file mode 100644 index 0000000..08cfcc3 --- /dev/null +++ b/packages/spectrocloud/tests/inclusive/fail.md @@ -0,0 +1,3 @@ +# Cluster Nodes + +Palette manages both the master and worker nodes in a cluster. The master nodes are responsible for managing the worker nodes, and the worker nodes are responsible for handling the workloads. diff --git a/packages/spectrocloud/tests/inclusive/pass.md b/packages/spectrocloud/tests/inclusive/pass.md new file mode 100644 index 0000000..5074902 --- /dev/null +++ b/packages/spectrocloud/tests/inclusive/pass.md @@ -0,0 +1,3 @@ +# Cluster Nodes + +The source code can be found in the master branch of the public repository. From 9d5a5b114235d118c0070b24de0a2bd0f0f2d304 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 25 Jun 2024 15:18:57 -0700 Subject: [PATCH 10/34] test: added new tests --- .../tests/longform/.vale.ini | 4 +++ .../tests/longform/fail.md | 15 ++++++++ .../tests/longform/pass.md | 15 ++++++++ .../styles/spectrocloud/longform.yml | 36 +++++++++---------- .../spectrocloud/tests/longform/.vale.ini | 4 +++ packages/spectrocloud/tests/longform/fail.md | 15 ++++++++ packages/spectrocloud/tests/longform/pass.md | 15 ++++++++ 7 files changed, 85 insertions(+), 19 deletions(-) create mode 100644 packages/spectrocloud-docs-internal/tests/longform/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/longform/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/longform/pass.md create mode 100644 packages/spectrocloud/tests/longform/.vale.ini create mode 100644 packages/spectrocloud/tests/longform/fail.md create mode 100644 packages/spectrocloud/tests/longform/pass.md diff --git a/packages/spectrocloud-docs-internal/tests/longform/.vale.ini b/packages/spectrocloud-docs-internal/tests/longform/.vale.ini new file mode 100644 index 0000000..1f638ff --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/longform/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Longform = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/longform/fail.md b/packages/spectrocloud-docs-internal/tests/longform/fail.md new file mode 100644 index 0000000..bfb57b5 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/longform/fail.md @@ -0,0 +1,15 @@ +## Debug Steps + +Use the following steps to debug the issue. + +1. Check the logs for any errors. + + ```shell + palette -h work -n + ``` + +2. Check the status of the pods. + + ```shell + kubeclt logs pod-name -n + ``` diff --git a/packages/spectrocloud-docs-internal/tests/longform/pass.md b/packages/spectrocloud-docs-internal/tests/longform/pass.md new file mode 100644 index 0000000..37e19d7 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/longform/pass.md @@ -0,0 +1,15 @@ +## Debug Steps + +Use the following steps to debug the issue. + +1. Check the logs for any errors. + +```shell +kubectl logs pod-name --namespace namespace +``` + +2. Check the status of the pods. + + ```shell + kubeclt logs pod-name --namespace + ``` diff --git a/packages/spectrocloud/styles/spectrocloud/longform.yml b/packages/spectrocloud/styles/spectrocloud/longform.yml index 3476ca7..f2d9ff0 100644 --- a/packages/spectrocloud/styles/spectrocloud/longform.yml +++ b/packages/spectrocloud/styles/spectrocloud/longform.yml @@ -1,7 +1,5 @@ # Copyright (c) Spectro Cloud # SPDX-License-Identifier: Apache-2.0 - ---- extends: existence message: "Avoid using the short form of commands. Replace the short form flag in '%s' with the corresponding long form flag." link: https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Commands-%26-Parameters @@ -9,21 +7,21 @@ level: error ignorecase: false scope: raw tokens: -# Match a word followed by one or more spaces, followed by the short form of a flag (one to three letters). The short flag can appear one or more times consecutively. For example: palette -h. - - (\b([\w]+))([\s ]{1,}[-][a-zA-Z]{1,3})+ + # Match a word followed by one or more spaces, followed by the short form of a flag (one to three letters). The short flag can appear one or more times consecutively. For example: palette -h. + - (\b([\w]+))([\s ]{1,}[-][a-zA-Z]{1,3})+ exceptions: - - ls([\s ]{1,}[-][a-zA-Z]{1,3})+ - - cd([\s ]{1,}[-][a-zA-Z]{1,3})+ - - cp([\s ]{1,}[-][a-zA-Z]{1,3})+ - - mv([\s ]{1,}[-][a-zA-Z]{1,3})+ - - rm([\s ]{1,}[-][a-zA-Z]{1,3})+ - - mkdir([\s ]{1,}[-][a-zA-Z]{1,3})+ - - rmdir([\s ]{1,}[-][a-zA-Z]{1,3})+ - - cat([\s ]{1,}[-][a-zA-Z]{1,3})+ - - pwd([\s ]{1,}[-][a-zA-Z]{1,3})+ - - echo([\s ]{1,}[-][a-zA-Z]{1,3})+ - - chmod([\s ]{1,}[-][a-zA-Z]{1,3})+ - - chown([\s ]{1,}[-][a-zA-Z]{1,3})+ - - sed([\s ]{1,}[-][a-zA-Z]{1,3})+ - - wc([\s ]{1,}[-][a-zA-Z]{1,3})+ - - tar([\s ]{1,}[-][a-zA-Z]{1,3})+ \ No newline at end of file + - ls([\s ]{1,}[-][a-zA-Z]{1,3})+ + - cd([\s ]{1,}[-][a-zA-Z]{1,3})+ + - cp([\s ]{1,}[-][a-zA-Z]{1,3})+ + - mv([\s ]{1,}[-][a-zA-Z]{1,3})+ + - rm([\s ]{1,}[-][a-zA-Z]{1,3})+ + - mkdir([\s ]{1,}[-][a-zA-Z]{1,3})+ + - rmdir([\s ]{1,}[-][a-zA-Z]{1,3})+ + - cat([\s ]{1,}[-][a-zA-Z]{1,3})+ + - pwd([\s ]{1,}[-][a-zA-Z]{1,3})+ + - echo([\s ]{1,}[-][a-zA-Z]{1,3})+ + - chmod([\s ]{1,}[-][a-zA-Z]{1,3})+ + - chown([\s ]{1,}[-][a-zA-Z]{1,3})+ + - sed([\s ]{1,}[-][a-zA-Z]{1,3})+ + - wc([\s ]{1,}[-][a-zA-Z]{1,3})+ + - tar([\s ]{1,}[-][a-zA-Z]{1,3})+ diff --git a/packages/spectrocloud/tests/longform/.vale.ini b/packages/spectrocloud/tests/longform/.vale.ini new file mode 100644 index 0000000..381c9c0 --- /dev/null +++ b/packages/spectrocloud/tests/longform/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Longform = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/longform/fail.md b/packages/spectrocloud/tests/longform/fail.md new file mode 100644 index 0000000..bfb57b5 --- /dev/null +++ b/packages/spectrocloud/tests/longform/fail.md @@ -0,0 +1,15 @@ +## Debug Steps + +Use the following steps to debug the issue. + +1. Check the logs for any errors. + + ```shell + palette -h work -n + ``` + +2. Check the status of the pods. + + ```shell + kubeclt logs pod-name -n + ``` diff --git a/packages/spectrocloud/tests/longform/pass.md b/packages/spectrocloud/tests/longform/pass.md new file mode 100644 index 0000000..37e19d7 --- /dev/null +++ b/packages/spectrocloud/tests/longform/pass.md @@ -0,0 +1,15 @@ +## Debug Steps + +Use the following steps to debug the issue. + +1. Check the logs for any errors. + +```shell +kubectl logs pod-name --namespace namespace +``` + +2. Check the status of the pods. + + ```shell + kubeclt logs pod-name --namespace + ``` From 29b1cdd6b0d2ce656494206e545a3cbe6b571d7d Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 25 Jun 2024 15:33:40 -0700 Subject: [PATCH 11/34] test: added more tests --- .../styles/spectrocloud-docs-internal/oxford-comma.yml | 2 +- packages/spectrocloud/styles/spectrocloud/oxford-comma.yml | 2 +- packages/spectrocloud/tests/oxford-comma/.vale.ini | 4 ++++ packages/spectrocloud/tests/oxford-comma/fail.md | 5 +++++ packages/spectrocloud/tests/oxford-comma/pass.md | 5 +++++ 5 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 packages/spectrocloud/tests/oxford-comma/.vale.ini create mode 100644 packages/spectrocloud/tests/oxford-comma/fail.md create mode 100644 packages/spectrocloud/tests/oxford-comma/pass.md diff --git a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/oxford-comma.yml b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/oxford-comma.yml index 227d86a..ae992d9 100644 --- a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/oxford-comma.yml +++ b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/oxford-comma.yml @@ -8,4 +8,4 @@ link: https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro scope: sentence nonword: true tokens: - - '(\b(?:\w+(?: \w+)?, )+\b(?:\w+(?: \w+)?) (?:and|or) \w+(?: \w+)?[.?!])' \ No newline at end of file + - '\b\w+(?: \w+)*, \w+(?: \w+)* (and|or) \w+(?: \w+)*[.?!]' diff --git a/packages/spectrocloud/styles/spectrocloud/oxford-comma.yml b/packages/spectrocloud/styles/spectrocloud/oxford-comma.yml index 227d86a..ae992d9 100644 --- a/packages/spectrocloud/styles/spectrocloud/oxford-comma.yml +++ b/packages/spectrocloud/styles/spectrocloud/oxford-comma.yml @@ -8,4 +8,4 @@ link: https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro scope: sentence nonword: true tokens: - - '(\b(?:\w+(?: \w+)?, )+\b(?:\w+(?: \w+)?) (?:and|or) \w+(?: \w+)?[.?!])' \ No newline at end of file + - '\b\w+(?: \w+)*, \w+(?: \w+)* (and|or) \w+(?: \w+)*[.?!]' diff --git a/packages/spectrocloud/tests/oxford-comma/.vale.ini b/packages/spectrocloud/tests/oxford-comma/.vale.ini new file mode 100644 index 0000000..d158a09 --- /dev/null +++ b/packages/spectrocloud/tests/oxford-comma/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Oxford-Comma = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/oxford-comma/fail.md b/packages/spectrocloud/tests/oxford-comma/fail.md new file mode 100644 index 0000000..1175761 --- /dev/null +++ b/packages/spectrocloud/tests/oxford-comma/fail.md @@ -0,0 +1,5 @@ +## Overview + +The project requires collaboration among engineers, designers and managers to succeed. + +From the left Main Menu, select Profiles and then select Add Cluster Profile. diff --git a/packages/spectrocloud/tests/oxford-comma/pass.md b/packages/spectrocloud/tests/oxford-comma/pass.md new file mode 100644 index 0000000..0342ac9 --- /dev/null +++ b/packages/spectrocloud/tests/oxford-comma/pass.md @@ -0,0 +1,5 @@ +## Overview + +With a unique approach to managing multiple clusters, Palette gives IT teams complete control, visibility, and production-scale efficiencies. + +From the left Main Menu, select Profiles, and then select Add Cluster Profile. From 3d04a805b70c29217f40d28d6457b91f806e5a4e Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 25 Jun 2024 15:34:16 -0700 Subject: [PATCH 12/34] test: more tests --- .../spectrocloud-docs-internal/tests/oxford-comma/.vale.ini | 4 ++++ .../spectrocloud-docs-internal/tests/oxford-comma/fail.md | 5 +++++ .../spectrocloud-docs-internal/tests/oxford-comma/pass.md | 5 +++++ 3 files changed, 14 insertions(+) create mode 100644 packages/spectrocloud-docs-internal/tests/oxford-comma/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/oxford-comma/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/oxford-comma/pass.md diff --git a/packages/spectrocloud-docs-internal/tests/oxford-comma/.vale.ini b/packages/spectrocloud-docs-internal/tests/oxford-comma/.vale.ini new file mode 100644 index 0000000..3392266 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/oxford-comma/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Oxford-Comma = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/oxford-comma/fail.md b/packages/spectrocloud-docs-internal/tests/oxford-comma/fail.md new file mode 100644 index 0000000..1175761 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/oxford-comma/fail.md @@ -0,0 +1,5 @@ +## Overview + +The project requires collaboration among engineers, designers and managers to succeed. + +From the left Main Menu, select Profiles and then select Add Cluster Profile. diff --git a/packages/spectrocloud-docs-internal/tests/oxford-comma/pass.md b/packages/spectrocloud-docs-internal/tests/oxford-comma/pass.md new file mode 100644 index 0000000..0342ac9 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/oxford-comma/pass.md @@ -0,0 +1,5 @@ +## Overview + +With a unique approach to managing multiple clusters, Palette gives IT teams complete control, visibility, and production-scale efficiencies. + +From the left Main Menu, select Profiles, and then select Add Cluster Profile. From 69c1ad68c172a6fe759aabd76bb3cb49effe24eb Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 09:12:17 -0700 Subject: [PATCH 13/34] ci: added vale version --- .github/workflows/pull_request.yml | 11 +++++++++++ .../spectrocloud/tests/plural-parantheses/.vale.ini | 4 ++++ .../spectrocloud/tests/plural-parantheses/fail.md | 7 +++++++ .../spectrocloud/tests/plural-parantheses/pass.md | 7 +++++++ 4 files changed, 29 insertions(+) create mode 100644 packages/spectrocloud/tests/plural-parantheses/.vale.ini create mode 100644 packages/spectrocloud/tests/plural-parantheses/fail.md create mode 100644 packages/spectrocloud/tests/plural-parantheses/pass.md diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index 6d21351..6b5dde3 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -8,6 +8,9 @@ concurrency: group: pr-${{ github.ref }} cancel-in-progress: true +env: + VALE_VERSION: "3.5.0" + jobs: run-ci: # runs-on: ubuntu-latest @@ -32,6 +35,14 @@ jobs: - name: Checkout Repository uses: actions/checkout@v4 + - name: Get Vale + run: | + URL="https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/vale_${VALE_VERSION}_Linux_64-bit.tar.gz" + wget --quiet $URL --output-document vale.tar.gz + tar -xzf vale.tar.gz + chmod +x vale + sudo mv vale /usr/local/bin/ + - name: Test Files Present? run: make required_files diff --git a/packages/spectrocloud/tests/plural-parantheses/.vale.ini b/packages/spectrocloud/tests/plural-parantheses/.vale.ini new file mode 100644 index 0000000..46e8310 --- /dev/null +++ b/packages/spectrocloud/tests/plural-parantheses/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Plural-Parantheses = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/plural-parantheses/fail.md b/packages/spectrocloud/tests/plural-parantheses/fail.md new file mode 100644 index 0000000..8f1d57f --- /dev/null +++ b/packages/spectrocloud/tests/plural-parantheses/fail.md @@ -0,0 +1,7 @@ +## Parameters + +The following parameter(s) are supported: + +- `name` (string, required): The name of the user. + +- `age` (number, required): The age of the user. diff --git a/packages/spectrocloud/tests/plural-parantheses/pass.md b/packages/spectrocloud/tests/plural-parantheses/pass.md new file mode 100644 index 0000000..53cd7cd --- /dev/null +++ b/packages/spectrocloud/tests/plural-parantheses/pass.md @@ -0,0 +1,7 @@ +## Parameters + +The following parameters are supported: + +- `name` (string, required): The name of the user. + +- `age` (number, required): The age of the user. From 11cbdf37426c6649f68de0c92504ef34551a5b7e Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 09:13:30 -0700 Subject: [PATCH 14/34] ci: verify vale --- .github/workflows/pull_request.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index 6b5dde3..5e6cec4 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -43,6 +43,9 @@ jobs: chmod +x vale sudo mv vale /usr/local/bin/ + - name: Vale Version + run: vale --version + - name: Test Files Present? run: make required_files From c1b07e16fd863d1f86d25234fb31b4b4d8ef0ce0 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 09:48:25 -0700 Subject: [PATCH 15/34] test: fixed file format --- .github/workflows/pull_request.yml | 2 +- .github/workflows/vale.yml | 2 +- ...arantheses.yaml => plural-parantheses.yml} | 0 .../{we.yaml => we.yml} | 0 .../tests/plural-parantheses/.vale.ini | 4 ++++ .../tests/plural-parantheses/fail.md | 13 +++++++++++ .../tests/plural-parantheses/pass.md | 7 ++++++ ...arantheses.yaml => plural-parantheses.yml} | 2 +- .../styles/spectrocloud/{we.yaml => we.yml} | 0 .../tests/plural-parantheses/fail.md | 8 ++++++- scripts/missing_tests.sh | 22 +++++++++++++++---- 11 files changed, 52 insertions(+), 8 deletions(-) rename packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/{plural-parantheses.yaml => plural-parantheses.yml} (100%) rename packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/{we.yaml => we.yml} (100%) create mode 100644 packages/spectrocloud-docs-internal/tests/plural-parantheses/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/plural-parantheses/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/plural-parantheses/pass.md rename packages/spectrocloud/styles/spectrocloud/{plural-parantheses.yaml => plural-parantheses.yml} (96%) rename packages/spectrocloud/styles/spectrocloud/{we.yaml => we.yml} (100%) diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index 5e6cec4..773f250 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -9,7 +9,7 @@ concurrency: cancel-in-progress: true env: - VALE_VERSION: "3.5.0" + VALE_VERSION: "3.6.0" jobs: run-ci: diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index a191d1f..746e338 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -3,7 +3,7 @@ on: inputs: version: description: "The version of the Vale to use" - default: "3.5.0" + default: "3.6.0" type: string required: false diff --git a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/plural-parantheses.yaml b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/plural-parantheses.yml similarity index 100% rename from packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/plural-parantheses.yaml rename to packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/plural-parantheses.yml diff --git a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/we.yaml b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/we.yml similarity index 100% rename from packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/we.yaml rename to packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/we.yml diff --git a/packages/spectrocloud-docs-internal/tests/plural-parantheses/.vale.ini b/packages/spectrocloud-docs-internal/tests/plural-parantheses/.vale.ini new file mode 100644 index 0000000..cb64237 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/plural-parantheses/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Plural-Parantheses = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/plural-parantheses/fail.md b/packages/spectrocloud-docs-internal/tests/plural-parantheses/fail.md new file mode 100644 index 0000000..689a44a --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/plural-parantheses/fail.md @@ -0,0 +1,13 @@ +## Parameters + +The following parameter(s) are supported. + +:::info + +The cluster node(s) will automatically scale down. + +::: + +- `name` (string, required): The name of the user. + +- `age` (number, required): The age of the user. diff --git a/packages/spectrocloud-docs-internal/tests/plural-parantheses/pass.md b/packages/spectrocloud-docs-internal/tests/plural-parantheses/pass.md new file mode 100644 index 0000000..53cd7cd --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/plural-parantheses/pass.md @@ -0,0 +1,7 @@ +## Parameters + +The following parameters are supported: + +- `name` (string, required): The name of the user. + +- `age` (number, required): The age of the user. diff --git a/packages/spectrocloud/styles/spectrocloud/plural-parantheses.yaml b/packages/spectrocloud/styles/spectrocloud/plural-parantheses.yml similarity index 96% rename from packages/spectrocloud/styles/spectrocloud/plural-parantheses.yaml rename to packages/spectrocloud/styles/spectrocloud/plural-parantheses.yml index 298bb32..f31919b 100644 --- a/packages/spectrocloud/styles/spectrocloud/plural-parantheses.yaml +++ b/packages/spectrocloud/styles/spectrocloud/plural-parantheses.yml @@ -12,4 +12,4 @@ action: - trim_right - "(s)" tokens: - - '\b\w+\(s\)' \ No newline at end of file + - '\b\w+\(s\)' diff --git a/packages/spectrocloud/styles/spectrocloud/we.yaml b/packages/spectrocloud/styles/spectrocloud/we.yml similarity index 100% rename from packages/spectrocloud/styles/spectrocloud/we.yaml rename to packages/spectrocloud/styles/spectrocloud/we.yml diff --git a/packages/spectrocloud/tests/plural-parantheses/fail.md b/packages/spectrocloud/tests/plural-parantheses/fail.md index 8f1d57f..689a44a 100644 --- a/packages/spectrocloud/tests/plural-parantheses/fail.md +++ b/packages/spectrocloud/tests/plural-parantheses/fail.md @@ -1,6 +1,12 @@ ## Parameters -The following parameter(s) are supported: +The following parameter(s) are supported. + +:::info + +The cluster node(s) will automatically scale down. + +::: - `name` (string, required): The name of the user. diff --git a/scripts/missing_tests.sh b/scripts/missing_tests.sh index 2629cf4..8270840 100755 --- a/scripts/missing_tests.sh +++ b/scripts/missing_tests.sh @@ -9,12 +9,17 @@ REQUIRED_FILES=(".vale.ini" "pass.md" "fail.md") # Counter for failed tests failed_tests=0 -# Function to get the rule name from the rule file path +# Function to get the rule name from the rule file path. If the file does not end with .yaml, it will return an error message. get_rule_name() { local rule_file="$1" - local rule_name=$(basename "$rule_file" .yml) - rule_name=${rule_name%.yaml} - echo "$rule_name" + if [[ "$rule_file" == *.yaml ]]; then + echo "" + echo "Error: The rule $rule_file ends with .yaml. Vale requires .yml instead. ❌" + echo "" + else + local rule_name=$(basename "$rule_file" .yml) + echo "$rule_name" + fi } # Function to check if test files exist @@ -42,6 +47,15 @@ check_test_files() { } +check_yaml_extension() { + local file="$1" + if [[ "$file" == *.yaml ]]; then + echo "The file ends with .yaml" + else + echo "The file does not end with .yaml" + fi +} + # Function to traverse the directory structure traverse_directories() { for package_dir in "$BASE_DIR"/*; do From 6d128b630ab46d20ea15d4ee637e0657726ce4d5 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 10:09:08 -0700 Subject: [PATCH 16/34] test: all test added --- .../{spectrocloud.yml => brand.yml} | 0 .../styles/spectrocloud-docs-internal/we.yml | 7 +++++-- .../tests/brand/.vale.ini | 4 ++++ .../tests/brand/fail.md | 3 +++ .../tests/brand/pass.md | 9 ++++++++ .../tests/product-ui/.vale.ini | 4 ++++ .../tests/product-ui/fail.md | 14 +++++++++++++ .../tests/product-ui/pass.md | 14 +++++++++++++ .../tests/we/.vale.ini | 4 ++++ .../tests/we/fail.md | 21 +++++++++++++++++++ .../tests/we/pass.md | 15 +++++++++++++ .../{spectrocloud.yml => brand.yml} | 0 .../spectrocloud/styles/spectrocloud/we.yml | 7 +++++-- packages/spectrocloud/tests/brand/.vale.ini | 4 ++++ packages/spectrocloud/tests/brand/fail.md | 3 +++ packages/spectrocloud/tests/brand/pass.md | 9 ++++++++ .../spectrocloud/tests/product-ui/.vale.ini | 4 ++++ .../spectrocloud/tests/product-ui/fail.md | 14 +++++++++++++ .../spectrocloud/tests/product-ui/pass.md | 14 +++++++++++++ packages/spectrocloud/tests/we/.vale.ini | 4 ++++ packages/spectrocloud/tests/we/fail.md | 21 +++++++++++++++++++ packages/spectrocloud/tests/we/pass.md | 15 +++++++++++++ 22 files changed, 186 insertions(+), 4 deletions(-) rename packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/{spectrocloud.yml => brand.yml} (100%) create mode 100644 packages/spectrocloud-docs-internal/tests/brand/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/brand/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/brand/pass.md create mode 100644 packages/spectrocloud-docs-internal/tests/product-ui/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/product-ui/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/product-ui/pass.md create mode 100644 packages/spectrocloud-docs-internal/tests/we/.vale.ini create mode 100644 packages/spectrocloud-docs-internal/tests/we/fail.md create mode 100644 packages/spectrocloud-docs-internal/tests/we/pass.md rename packages/spectrocloud/styles/spectrocloud/{spectrocloud.yml => brand.yml} (100%) create mode 100644 packages/spectrocloud/tests/brand/.vale.ini create mode 100644 packages/spectrocloud/tests/brand/fail.md create mode 100644 packages/spectrocloud/tests/brand/pass.md create mode 100644 packages/spectrocloud/tests/product-ui/.vale.ini create mode 100644 packages/spectrocloud/tests/product-ui/fail.md create mode 100644 packages/spectrocloud/tests/product-ui/pass.md create mode 100644 packages/spectrocloud/tests/we/.vale.ini create mode 100644 packages/spectrocloud/tests/we/fail.md create mode 100644 packages/spectrocloud/tests/we/pass.md diff --git a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/spectrocloud.yml b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/brand.yml similarity index 100% rename from packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/spectrocloud.yml rename to packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/brand.yml diff --git a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/we.yml b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/we.yml index 38cd2fd..e2801f1 100644 --- a/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/we.yml +++ b/packages/spectrocloud-docs-internal/styles/spectrocloud-docs-internal/we.yml @@ -2,11 +2,14 @@ # SPDX-License-Identifier: Apache-2.0 extends: existence -message: "Try to avoid using first-person plural. Use terms like '%s' instead of '%s'." -link: 'https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Active-voice' +message: "Try to avoid using first-person plural. Avoid terms such as '%s'. Address the user directly." +link: "https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Active-voice" level: warning ignorecase: true tokens: - ours? - us - let's + - we can +exceptions: + - we recommend diff --git a/packages/spectrocloud-docs-internal/tests/brand/.vale.ini b/packages/spectrocloud-docs-internal/tests/brand/.vale.ini new file mode 100644 index 0000000..7f199c8 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/brand/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Brand = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/brand/fail.md b/packages/spectrocloud-docs-internal/tests/brand/fail.md new file mode 100644 index 0000000..fca87ab --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/brand/fail.md @@ -0,0 +1,3 @@ +## Company Information + +The organization, spectro cloud, was founded in 2019. We can be reached at support@spectrocloud.com diff --git a/packages/spectrocloud-docs-internal/tests/brand/pass.md b/packages/spectrocloud-docs-internal/tests/brand/pass.md new file mode 100644 index 0000000..d33c840 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/brand/pass.md @@ -0,0 +1,9 @@ +## Company Information + +The organization, Spectro Cloud, was founded in 2019. We can be reached at support@spectrocloud.com. You can also visit our website at [https://spectrocloud.com](https://spectrocloud.com). + +We also have a hidden CLI. + +```shell +spectrocloud --version +``` diff --git a/packages/spectrocloud-docs-internal/tests/product-ui/.vale.ini b/packages/spectrocloud-docs-internal/tests/product-ui/.vale.ini new file mode 100644 index 0000000..bfd80fa --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/product-ui/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.Product-UI = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/product-ui/fail.md b/packages/spectrocloud-docs-internal/tests/product-ui/fail.md new file mode 100644 index 0000000..aee8785 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/product-ui/fail.md @@ -0,0 +1,14 @@ +# Enable Feature + +Use the following steps to enable the specical feature. + +1. Log in to Palette. + +2. Navigate to the nav bar and select **Features**. + +3. Select the three dots and click on "Enable Feature". + + :::note + + The dropdown menu on the side also contains more options. + ::: diff --git a/packages/spectrocloud-docs-internal/tests/product-ui/pass.md b/packages/spectrocloud-docs-internal/tests/product-ui/pass.md new file mode 100644 index 0000000..6599b77 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/product-ui/pass.md @@ -0,0 +1,14 @@ +# Enable Feature + +Use the following steps to enable the specical feature. + +1. Log in to Palette. + +2. Navigate to the left **Main Menu** and select **Features**. + +3. Select the **three-dots Menu** and click on "Enable Feature". + + :::note + + The **drop-down Menu** on the side also contains more options. + ::: diff --git a/packages/spectrocloud-docs-internal/tests/we/.vale.ini b/packages/spectrocloud-docs-internal/tests/we/.vale.ini new file mode 100644 index 0000000..2b4eeb7 --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/we/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud-docs-internal.We = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/we/fail.md b/packages/spectrocloud-docs-internal/tests/we/fail.md new file mode 100644 index 0000000..0a6f68d --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/we/fail.md @@ -0,0 +1,21 @@ +# Debug Steps + +Let's dive into the debugging steps to resolve the issue. + +:::note + +Before you begin, take note of how us and other orgs use the kubectl tool. + +::: + +1. We recommend clearing the cache before you begin. + + ```shell + kubectl cache clear + ``` + + :::tip + + We can also use the `kubectl clear --cache` command. + + ::: diff --git a/packages/spectrocloud-docs-internal/tests/we/pass.md b/packages/spectrocloud-docs-internal/tests/we/pass.md new file mode 100644 index 0000000..d2c687a --- /dev/null +++ b/packages/spectrocloud-docs-internal/tests/we/pass.md @@ -0,0 +1,15 @@ +# Debug Steps + +Use the following steps to resolve the issue. + +:::note + +We use kubectl in a distinct way. Make sure you understand the differences by reviewing the longform flags. + +::: + +1. We recommend clearing the cache before you begin. + + ```shell + kubectl cache clear + ``` diff --git a/packages/spectrocloud/styles/spectrocloud/spectrocloud.yml b/packages/spectrocloud/styles/spectrocloud/brand.yml similarity index 100% rename from packages/spectrocloud/styles/spectrocloud/spectrocloud.yml rename to packages/spectrocloud/styles/spectrocloud/brand.yml diff --git a/packages/spectrocloud/styles/spectrocloud/we.yml b/packages/spectrocloud/styles/spectrocloud/we.yml index 38cd2fd..e2801f1 100644 --- a/packages/spectrocloud/styles/spectrocloud/we.yml +++ b/packages/spectrocloud/styles/spectrocloud/we.yml @@ -2,11 +2,14 @@ # SPDX-License-Identifier: Apache-2.0 extends: existence -message: "Try to avoid using first-person plural. Use terms like '%s' instead of '%s'." -link: 'https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Active-voice' +message: "Try to avoid using first-person plural. Avoid terms such as '%s'. Address the user directly." +link: "https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Active-voice" level: warning ignorecase: true tokens: - ours? - us - let's + - we can +exceptions: + - we recommend diff --git a/packages/spectrocloud/tests/brand/.vale.ini b/packages/spectrocloud/tests/brand/.vale.ini new file mode 100644 index 0000000..ff6f6fa --- /dev/null +++ b/packages/spectrocloud/tests/brand/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Brand = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/brand/fail.md b/packages/spectrocloud/tests/brand/fail.md new file mode 100644 index 0000000..fca87ab --- /dev/null +++ b/packages/spectrocloud/tests/brand/fail.md @@ -0,0 +1,3 @@ +## Company Information + +The organization, spectro cloud, was founded in 2019. We can be reached at support@spectrocloud.com diff --git a/packages/spectrocloud/tests/brand/pass.md b/packages/spectrocloud/tests/brand/pass.md new file mode 100644 index 0000000..d33c840 --- /dev/null +++ b/packages/spectrocloud/tests/brand/pass.md @@ -0,0 +1,9 @@ +## Company Information + +The organization, Spectro Cloud, was founded in 2019. We can be reached at support@spectrocloud.com. You can also visit our website at [https://spectrocloud.com](https://spectrocloud.com). + +We also have a hidden CLI. + +```shell +spectrocloud --version +``` diff --git a/packages/spectrocloud/tests/product-ui/.vale.ini b/packages/spectrocloud/tests/product-ui/.vale.ini new file mode 100644 index 0000000..7868407 --- /dev/null +++ b/packages/spectrocloud/tests/product-ui/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.Product-UI = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/product-ui/fail.md b/packages/spectrocloud/tests/product-ui/fail.md new file mode 100644 index 0000000..aee8785 --- /dev/null +++ b/packages/spectrocloud/tests/product-ui/fail.md @@ -0,0 +1,14 @@ +# Enable Feature + +Use the following steps to enable the specical feature. + +1. Log in to Palette. + +2. Navigate to the nav bar and select **Features**. + +3. Select the three dots and click on "Enable Feature". + + :::note + + The dropdown menu on the side also contains more options. + ::: diff --git a/packages/spectrocloud/tests/product-ui/pass.md b/packages/spectrocloud/tests/product-ui/pass.md new file mode 100644 index 0000000..6599b77 --- /dev/null +++ b/packages/spectrocloud/tests/product-ui/pass.md @@ -0,0 +1,14 @@ +# Enable Feature + +Use the following steps to enable the specical feature. + +1. Log in to Palette. + +2. Navigate to the left **Main Menu** and select **Features**. + +3. Select the **three-dots Menu** and click on "Enable Feature". + + :::note + + The **drop-down Menu** on the side also contains more options. + ::: diff --git a/packages/spectrocloud/tests/we/.vale.ini b/packages/spectrocloud/tests/we/.vale.ini new file mode 100644 index 0000000..266f33e --- /dev/null +++ b/packages/spectrocloud/tests/we/.vale.ini @@ -0,0 +1,4 @@ +StylesPath = ../../styles/ +MinAlertLevel = suggestion +[*.md] +spectrocloud.We = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/we/fail.md b/packages/spectrocloud/tests/we/fail.md new file mode 100644 index 0000000..0a6f68d --- /dev/null +++ b/packages/spectrocloud/tests/we/fail.md @@ -0,0 +1,21 @@ +# Debug Steps + +Let's dive into the debugging steps to resolve the issue. + +:::note + +Before you begin, take note of how us and other orgs use the kubectl tool. + +::: + +1. We recommend clearing the cache before you begin. + + ```shell + kubectl cache clear + ``` + + :::tip + + We can also use the `kubectl clear --cache` command. + + ::: diff --git a/packages/spectrocloud/tests/we/pass.md b/packages/spectrocloud/tests/we/pass.md new file mode 100644 index 0000000..d2c687a --- /dev/null +++ b/packages/spectrocloud/tests/we/pass.md @@ -0,0 +1,15 @@ +# Debug Steps + +Use the following steps to resolve the issue. + +:::note + +We use kubectl in a distinct way. Make sure you understand the differences by reviewing the longform flags. + +::: + +1. We recommend clearing the cache before you begin. + + ```shell + kubectl cache clear + ``` From 5d86f719b3f19f00f9656e8c40a1d4951046dfb1 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 10:11:54 -0700 Subject: [PATCH 17/34] ci: fix bash error --- scripts/check_rule.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index 344090d..7fcbd01 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -11,7 +11,7 @@ failed_tests=0 get_last_directory_name() { dir_path=$1 base_name=$(basename "$dir_path") - capitalized_name="$(tr '[:lower:]' '[:upper:]' <<< ${base_name:0:1})${base_name:1}" + capitalized_name="$(echo "${base_name:0:1}" | tr '[:lower:]' '[:upper:]')${base_name:1}" echo "$capitalized_name" } From 711381e814401d7b5348de70ba94b2b0a586f003 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 10:13:31 -0700 Subject: [PATCH 18/34] ci: another approach --- scripts/check_rule.sh | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index 7fcbd01..ab5848b 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -11,10 +11,11 @@ failed_tests=0 get_last_directory_name() { dir_path=$1 base_name=$(basename "$dir_path") - capitalized_name="$(echo "${base_name:0:1}" | tr '[:lower:]' '[:upper:]')${base_name:1}" + first_char=$(echo "$base_name" | cut -c1 | tr '[:lower:]' '[:upper:]') + rest_chars=$(echo "$base_name" | cut -c2-) + capitalized_name="${first_char}${rest_chars}" echo "$capitalized_name" } - # This function extracts the first folder name (package name) from a given path. get_package_name() { dir_path=$1 From be6eae57b980b9dec1f3901c6c9f811888885a7c Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 10:20:02 -0700 Subject: [PATCH 19/34] ci: more tests --- scripts/check_rule.sh | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index ab5848b..bc3bc21 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -47,20 +47,20 @@ check_pass_conditions() { exit 1 fi - RESULT=$(vale --config="$config_file" --no-exit --output=line "$pass_md_file" | wc -l) - + RESULT=$(vale --config="$config_file" --no-exit --output=line "$pass_md_file" | wc -l) if [ "$RESULT" -ne 0 ]; then - echo "$package_name/$rule_name fail condition test - ❌" - log=$(vale --config="$config_file" --output=line "$pass_md_file") - echo "Debug: $log" + echo "$package_name/$rule_name fail condition test - ❌" + log=$(vale --config="$config_file" --output=line "$pass_md_file") + echo "Debug: $log" failed_tests=$((failed_tests + 1)) - return 1 + return 1 fi echo "$package_name/$rule_name pass condition test - ✅" } + # This function checks the fail conditions for the Vale rule. A file with the name fail.md is expected to be present. # The function takes one argument which is the base directory # The expected folder structure is base_directory/.vale.ini and base_directory/fail.md From 3982024c7b6378cec3605ae15510d126527e98cd Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 10:21:35 -0700 Subject: [PATCH 20/34] ci: add debug --- scripts/check_rule.sh | 2 ++ 1 file changed, 2 insertions(+) diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index bc3bc21..7249dd4 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -89,6 +89,8 @@ check_fail_conditions() { if [ "$RESULT" -eq 0 ]; then echo "$package_name/$rule_name fail condition test - ❌" + log=$(vale --config="$config_file" --output=line "$fail_md_file") + echo "Debug: $log" failed_tests=$((failed_tests + 1)) return 1 fi From c078e3e44597b7aefdf4fbfcc9e518062dc77b23 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 10:24:30 -0700 Subject: [PATCH 21/34] ci: more debug --- scripts/check_rule.sh | 3 +++ 1 file changed, 3 insertions(+) diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index 7249dd4..f7ad14a 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -87,6 +87,9 @@ check_fail_conditions() { RESULT=$(vale --config="$config_file" --no-exit --output=line "$fail_md_file" | wc -l) + # Debugging: Print the RESULT value + echo "RESULT: $RESULT" + if [ "$RESULT" -eq 0 ]; then echo "$package_name/$rule_name fail condition test - ❌" log=$(vale --config="$config_file" --output=line "$fail_md_file") From 8d41069c624f1f93f42cdf9079a6bdd37dfbf943 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 10:28:02 -0700 Subject: [PATCH 22/34] ci: more debug --- scripts/check_rule.sh | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index f7ad14a..a904f7c 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -87,10 +87,7 @@ check_fail_conditions() { RESULT=$(vale --config="$config_file" --no-exit --output=line "$fail_md_file" | wc -l) - # Debugging: Print the RESULT value - echo "RESULT: $RESULT" - - if [ "$RESULT" -eq 0 ]; then + if [ -z $RESULT ]; then echo "$package_name/$rule_name fail condition test - ❌" log=$(vale --config="$config_file" --output=line "$fail_md_file") echo "Debug: $log" From cb5038fdbc295932603bd97c42f6bbed022354bb Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 10:29:40 -0700 Subject: [PATCH 23/34] ci: test --- packages/spectrocloud/tests/ableism/pass.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/spectrocloud/tests/ableism/pass.md b/packages/spectrocloud/tests/ableism/pass.md index cee6b73..b12ebf4 100644 --- a/packages/spectrocloud/tests/ableism/pass.md +++ b/packages/spectrocloud/tests/ableism/pass.md @@ -6,4 +6,4 @@ You can access the cluster by issuing the following command. kubectl get pods ``` -The output displays all the pods active in the cluster. +The output displays all the pods active in the cluster. See that From 9217683f69850069cfec3795ac9f994e462e3d80 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 12:28:55 -0700 Subject: [PATCH 24/34] ci: investiage false positive --- packages/spectrocloud/tests/ableism/pass.md | 2 +- scripts/check_rule.sh | 2 +- scripts/create_zip.sh | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/spectrocloud/tests/ableism/pass.md b/packages/spectrocloud/tests/ableism/pass.md index b12ebf4..cd3a944 100644 --- a/packages/spectrocloud/tests/ableism/pass.md +++ b/packages/spectrocloud/tests/ableism/pass.md @@ -6,4 +6,4 @@ You can access the cluster by issuing the following command. kubectl get pods ``` -The output displays all the pods active in the cluster. See that +The output displays all the pods active in the cluster. See the cluster diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index a904f7c..ea05edc 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -1,4 +1,4 @@ -#!/bin/sh +#!/bin/bash # Copyright (c) Spectro Cloud # SPDX-License-Identifier: Apache-2.0 diff --git a/scripts/create_zip.sh b/scripts/create_zip.sh index e9b3114..8a601e7 100755 --- a/scripts/create_zip.sh +++ b/scripts/create_zip.sh @@ -1,4 +1,4 @@ -#!/bin/sh +#!/bin/bash # Copyright (c) Spectro Cloud # SPDX-License-Identifier: Apache-2.0 From 52fa214b15d7bdf2c67a66ea580262192747d6e6 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 12:32:17 -0700 Subject: [PATCH 25/34] ci: more debug --- scripts/check_rule.sh | 2 ++ 1 file changed, 2 insertions(+) diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index ea05edc..85e0fb7 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -48,6 +48,8 @@ check_pass_conditions() { fi RESULT=$(vale --config="$config_file" --no-exit --output=line "$pass_md_file" | wc -l) + debug=$(vale --config="$config_file" --output=line "$pass_md_file") + echo "Debug: $debug" if [ "$RESULT" -ne 0 ]; then echo "$package_name/$rule_name fail condition test - ❌" From f8bb59f0995f1ad5ec586b08852ca5b3a467a1c8 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 12:34:27 -0700 Subject: [PATCH 26/34] ci: more debug --- Makefile | 4 ++-- scripts/check_rule.sh | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 2a5955d..c68f60e 100644 --- a/Makefile +++ b/Makefile @@ -15,12 +15,12 @@ init: ## Initialize the project required_files: ## Check if required files are present @echo "Checking if required files are present..." - ./scripts/missing_tests.sh packages/ + ./scripts/missing_tests.sh packages tests: ## Run tests @echo "Running tests..." - ./scripts/check_rule.sh packages/ + ./scripts/check_rule.sh packages ##@ Publish diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index 85e0fb7..003c22a 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -46,7 +46,7 @@ check_pass_conditions() { echo "Error: $base_directory does not contain a file named .vale.ini" exit 1 fi - + echo "vale --config=$config_file --no-exit --output=line $pass_md_file" RESULT=$(vale --config="$config_file" --no-exit --output=line "$pass_md_file" | wc -l) debug=$(vale --config="$config_file" --output=line "$pass_md_file") echo "Debug: $debug" From 7a4a618b90e1ec159768bfccfa9a70895c8c6343 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 12:37:54 -0700 Subject: [PATCH 27/34] ci: more debug --- scripts/check_rule.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index 003c22a..5214e2a 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -107,6 +107,7 @@ traverse_and_check() { # Traverse the packages directory and look one level down for package_dir in "$base_directory"/*; do if [ -d "$package_dir/tests" ]; then + echo "Checking Vale rules for package: $package_dir" # Walk the tests directory for sub-directories echo "" From 3c48abc7716955a39e945b8ada1c6a283a87236b Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 12:42:11 -0700 Subject: [PATCH 28/34] ci: debug --- scripts/check_rule.sh | 3 +++ 1 file changed, 3 insertions(+) diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index 5214e2a..b2eeec5 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -50,6 +50,8 @@ check_pass_conditions() { RESULT=$(vale --config="$config_file" --no-exit --output=line "$pass_md_file" | wc -l) debug=$(vale --config="$config_file" --output=line "$pass_md_file") echo "Debug: $debug" + cat $pass_md_file + cat $config_file if [ "$RESULT" -ne 0 ]; then echo "$package_name/$rule_name fail condition test - ❌" @@ -108,6 +110,7 @@ traverse_and_check() { for package_dir in "$base_directory"/*; do if [ -d "$package_dir/tests" ]; then echo "Checking Vale rules for package: $package_dir" + # Walk the tests directory for sub-directories echo "" From 922bc23349732a96a8a843da4e54826900ddfd4c Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 12:43:35 -0700 Subject: [PATCH 29/34] ci: test --- scripts/check_rule.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index b2eeec5..7f62303 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -52,6 +52,7 @@ check_pass_conditions() { echo "Debug: $debug" cat $pass_md_file cat $config_file + echo "" if [ "$RESULT" -ne 0 ]; then echo "$package_name/$rule_name fail condition test - ❌" From 84f2afc8cc00b3dc2146a5fea9f17c8d7f3bfdc8 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 12:48:40 -0700 Subject: [PATCH 30/34] test: debug --- .github/workflows/pull_request.yml | 11 +++++++---- scripts/check_rule.sh | 12 ++++++------ 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index 773f250..5af158c 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -43,11 +43,14 @@ jobs: chmod +x vale sudo mv vale /usr/local/bin/ - - name: Vale Version - run: vale --version + - name: debug + run: vale --config=packages/spectrocloud/tests/ableism/.vale.ini packages/spectrocloud/tests/ableism/pass.md - - name: Test Files Present? - run: make required_files + # - name: Vale Version + # run: vale --version + + # - name: Test Files Present? + # run: make required_files - name: Tests run: make tests diff --git a/scripts/check_rule.sh b/scripts/check_rule.sh index 7f62303..da1eb6c 100755 --- a/scripts/check_rule.sh +++ b/scripts/check_rule.sh @@ -46,13 +46,13 @@ check_pass_conditions() { echo "Error: $base_directory does not contain a file named .vale.ini" exit 1 fi - echo "vale --config=$config_file --no-exit --output=line $pass_md_file" + # echo "vale --config=$config_file --no-exit --output=line $pass_md_file" RESULT=$(vale --config="$config_file" --no-exit --output=line "$pass_md_file" | wc -l) - debug=$(vale --config="$config_file" --output=line "$pass_md_file") - echo "Debug: $debug" - cat $pass_md_file - cat $config_file - echo "" + # debug=$(vale --config="$config_file" --output=line "$pass_md_file") + # echo "Debug: $debug" + # cat $pass_md_file + # cat $config_file + # echo "" if [ "$RESULT" -ne 0 ]; then echo "$package_name/$rule_name fail condition test - ❌" From 8f3d8a74246fbb186d6883bef78964c39712962c Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 13:20:21 -0700 Subject: [PATCH 31/34] ci: more debug --- .github/workflows/pull_request.yml | 2 +- packages/spectrocloud/tests/ableism/{.vale.ini => vale.ini} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename packages/spectrocloud/tests/ableism/{.vale.ini => vale.ini} (100%) diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index 5af158c..1db7ca8 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -44,7 +44,7 @@ jobs: sudo mv vale /usr/local/bin/ - name: debug - run: vale --config=packages/spectrocloud/tests/ableism/.vale.ini packages/spectrocloud/tests/ableism/pass.md + run: vale --config=packages/spectrocloud/tests/ableism/vale.ini packages/spectrocloud/tests/ableism/pass.md # - name: Vale Version # run: vale --version diff --git a/packages/spectrocloud/tests/ableism/.vale.ini b/packages/spectrocloud/tests/ableism/vale.ini similarity index 100% rename from packages/spectrocloud/tests/ableism/.vale.ini rename to packages/spectrocloud/tests/ableism/vale.ini From e1f4af97008c38a3c240c974e72a9399c7cb6927 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 14:27:26 -0700 Subject: [PATCH 32/34] ci: progress --- .github/workflows/pull_request.yml | 10 +++++----- Dockerfile | 18 ++++++++++++++++++ .../tests/ableism/{vale.ini => .vale.ini} | 2 +- packages/spectrocloud/tests/acronym/.vale.ini | 2 +- .../spectrocloud/tests/admonitions/.vale.ini | 2 +- packages/spectrocloud/tests/brand/.vale.ini | 2 +- .../spectrocloud/tests/condescending/.vale.ini | 2 +- .../spectrocloud/tests/direction/.vale.ini | 2 +- .../spectrocloud/tests/file-type/.vale.ini | 2 +- packages/spectrocloud/tests/future/.vale.ini | 2 +- packages/spectrocloud/tests/gender/.vale.ini | 2 +- .../tests/headings-title/.vale.ini | 2 +- .../spectrocloud/tests/inclusive/.vale.ini | 2 +- packages/spectrocloud/tests/longform/.vale.ini | 2 +- .../spectrocloud/tests/oxford-comma/.vale.ini | 2 +- .../tests/plural-parantheses/.vale.ini | 2 +- .../spectrocloud/tests/product-ui/.vale.ini | 2 +- 17 files changed, 38 insertions(+), 20 deletions(-) create mode 100644 Dockerfile rename packages/spectrocloud/tests/ableism/{vale.ini => .vale.ini} (70%) diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index 1db7ca8..a7292dd 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -44,13 +44,13 @@ jobs: sudo mv vale /usr/local/bin/ - name: debug - run: vale --config=packages/spectrocloud/tests/ableism/vale.ini packages/spectrocloud/tests/ableism/pass.md + run: vale --config=packages/spectrocloud/tests/ableism/.vale.ini packages/spectrocloud/tests/ableism/pass.md - # - name: Vale Version - # run: vale --version + - name: Vale Version + run: vale --version - # - name: Test Files Present? - # run: make required_files + - name: Test Files Present? + run: make required_files - name: Tests run: make tests diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..159bb9c --- /dev/null +++ b/Dockerfile @@ -0,0 +1,18 @@ +FROM ubuntu:24.04 + +COPY . /app + +ENV VALE_VERSION="2.3.0" + +RUN apt-get update && apt-get install wget make -y + +RUN URL="https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/vale_${VALE_VERSION}_Linux_64-bit.tar.gz" && \ + wget --quiet $URL --output-document vale.tar.gz && \ + tar -xzf vale.tar.gz && \ + chmod +x vale && \ + mv vale /usr/local/bin/ + +WORKDIR /app + + +CMD ["make", "tests"] \ No newline at end of file diff --git a/packages/spectrocloud/tests/ableism/vale.ini b/packages/spectrocloud/tests/ableism/.vale.ini similarity index 70% rename from packages/spectrocloud/tests/ableism/vale.ini rename to packages/spectrocloud/tests/ableism/.vale.ini index dff6faf..4fa4193 100644 --- a/packages/spectrocloud/tests/ableism/vale.ini +++ b/packages/spectrocloud/tests/ableism/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Ableism = YES \ No newline at end of file +spectrocloud.ableism = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/acronym/.vale.ini b/packages/spectrocloud/tests/acronym/.vale.ini index c59f5bf..3d853db 100644 --- a/packages/spectrocloud/tests/acronym/.vale.ini +++ b/packages/spectrocloud/tests/acronym/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Acronym = YES \ No newline at end of file +spectrocloud.acronym = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/admonitions/.vale.ini b/packages/spectrocloud/tests/admonitions/.vale.ini index 3109df8..11ff097 100644 --- a/packages/spectrocloud/tests/admonitions/.vale.ini +++ b/packages/spectrocloud/tests/admonitions/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Admonitions = YES \ No newline at end of file +spectrocloud.admonitions = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/brand/.vale.ini b/packages/spectrocloud/tests/brand/.vale.ini index ff6f6fa..6be2d8c 100644 --- a/packages/spectrocloud/tests/brand/.vale.ini +++ b/packages/spectrocloud/tests/brand/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Brand = YES \ No newline at end of file +spectrocloud.brand = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/condescending/.vale.ini b/packages/spectrocloud/tests/condescending/.vale.ini index 79220bb..fe583a4 100644 --- a/packages/spectrocloud/tests/condescending/.vale.ini +++ b/packages/spectrocloud/tests/condescending/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Condescending = YES +spectrocloud.condescending = YES diff --git a/packages/spectrocloud/tests/direction/.vale.ini b/packages/spectrocloud/tests/direction/.vale.ini index 38b96ae..5ab7260 100644 --- a/packages/spectrocloud/tests/direction/.vale.ini +++ b/packages/spectrocloud/tests/direction/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Direction = YES \ No newline at end of file +spectrocloud.direction = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/file-type/.vale.ini b/packages/spectrocloud/tests/file-type/.vale.ini index 1a1498c..5de1d3b 100644 --- a/packages/spectrocloud/tests/file-type/.vale.ini +++ b/packages/spectrocloud/tests/file-type/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.File-Type = YES +spectrocloud.file-type = YES diff --git a/packages/spectrocloud/tests/future/.vale.ini b/packages/spectrocloud/tests/future/.vale.ini index a7b209e..6a4075f 100644 --- a/packages/spectrocloud/tests/future/.vale.ini +++ b/packages/spectrocloud/tests/future/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Future = YES \ No newline at end of file +spectrocloud.future = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/gender/.vale.ini b/packages/spectrocloud/tests/gender/.vale.ini index 0efb3a3..b13dd6b 100644 --- a/packages/spectrocloud/tests/gender/.vale.ini +++ b/packages/spectrocloud/tests/gender/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Gender = YES \ No newline at end of file +spectrocloud.gender = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/headings-title/.vale.ini b/packages/spectrocloud/tests/headings-title/.vale.ini index aa6019c..9eacd66 100644 --- a/packages/spectrocloud/tests/headings-title/.vale.ini +++ b/packages/spectrocloud/tests/headings-title/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Headings-Title = YES \ No newline at end of file +spectrocloud.headings-title = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/inclusive/.vale.ini b/packages/spectrocloud/tests/inclusive/.vale.ini index 5afd805..aab07d4 100644 --- a/packages/spectrocloud/tests/inclusive/.vale.ini +++ b/packages/spectrocloud/tests/inclusive/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Inclusive = YES \ No newline at end of file +spectrocloud.inclusive = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/longform/.vale.ini b/packages/spectrocloud/tests/longform/.vale.ini index 381c9c0..14088b0 100644 --- a/packages/spectrocloud/tests/longform/.vale.ini +++ b/packages/spectrocloud/tests/longform/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Longform = YES \ No newline at end of file +spectrocloud.longform = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/oxford-comma/.vale.ini b/packages/spectrocloud/tests/oxford-comma/.vale.ini index d158a09..55c3145 100644 --- a/packages/spectrocloud/tests/oxford-comma/.vale.ini +++ b/packages/spectrocloud/tests/oxford-comma/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Oxford-Comma = YES \ No newline at end of file +spectrocloud.oxford-comma = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/plural-parantheses/.vale.ini b/packages/spectrocloud/tests/plural-parantheses/.vale.ini index 46e8310..a24e4ac 100644 --- a/packages/spectrocloud/tests/plural-parantheses/.vale.ini +++ b/packages/spectrocloud/tests/plural-parantheses/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Plural-Parantheses = YES \ No newline at end of file +spectrocloud.plural-parantheses = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/product-ui/.vale.ini b/packages/spectrocloud/tests/product-ui/.vale.ini index 7868407..8bf705d 100644 --- a/packages/spectrocloud/tests/product-ui/.vale.ini +++ b/packages/spectrocloud/tests/product-ui/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Product-UI = YES \ No newline at end of file +spectrocloud.product-ui = YES \ No newline at end of file From 5e3c583d9fb7904381250074d8c26a023cb7e73e Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 14:31:22 -0700 Subject: [PATCH 33/34] chore: tests --- .github/workflows/pull_request.yml | 3 --- packages/spectrocloud-docs-internal/tests/ableism/.vale.ini | 2 +- packages/spectrocloud-docs-internal/tests/acronym/.vale.ini | 2 +- .../spectrocloud-docs-internal/tests/admonitions/.vale.ini | 2 +- packages/spectrocloud-docs-internal/tests/brand/.vale.ini | 2 +- packages/spectrocloud-docs-internal/tests/colon/.vale.ini | 2 +- .../spectrocloud-docs-internal/tests/condescending/.vale.ini | 2 +- packages/spectrocloud-docs-internal/tests/direction/.vale.ini | 2 +- packages/spectrocloud-docs-internal/tests/file-type/.vale.ini | 2 +- packages/spectrocloud-docs-internal/tests/future/.vale.ini | 2 +- packages/spectrocloud-docs-internal/tests/gender/.vale.ini | 2 +- .../spectrocloud-docs-internal/tests/headings-title/.vale.ini | 2 +- packages/spectrocloud-docs-internal/tests/inclusive/.vale.ini | 2 +- packages/spectrocloud-docs-internal/tests/longform/.vale.ini | 2 +- .../spectrocloud-docs-internal/tests/oxford-comma/.vale.ini | 2 +- .../tests/plural-parantheses/.vale.ini | 2 +- packages/spectrocloud-docs-internal/tests/product-ui/.vale.ini | 2 +- packages/spectrocloud-docs-internal/tests/we/.vale.ini | 2 +- packages/spectrocloud/tests/colon/.vale.ini | 2 +- packages/spectrocloud/tests/we/.vale.ini | 2 +- 20 files changed, 19 insertions(+), 22 deletions(-) diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index a7292dd..773f250 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -43,9 +43,6 @@ jobs: chmod +x vale sudo mv vale /usr/local/bin/ - - name: debug - run: vale --config=packages/spectrocloud/tests/ableism/.vale.ini packages/spectrocloud/tests/ableism/pass.md - - name: Vale Version run: vale --version diff --git a/packages/spectrocloud-docs-internal/tests/ableism/.vale.ini b/packages/spectrocloud-docs-internal/tests/ableism/.vale.ini index 4edb2e1..d82a04b 100644 --- a/packages/spectrocloud-docs-internal/tests/ableism/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/ableism/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Ableism = YES \ No newline at end of file +spectrocloud-docs-internal.ableism = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/acronym/.vale.ini b/packages/spectrocloud-docs-internal/tests/acronym/.vale.ini index 1bdadb0..3b24c33 100644 --- a/packages/spectrocloud-docs-internal/tests/acronym/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/acronym/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Acronym = YES \ No newline at end of file +spectrocloud-docs-internal.acronym = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/admonitions/.vale.ini b/packages/spectrocloud-docs-internal/tests/admonitions/.vale.ini index be7d45f..a4244d2 100644 --- a/packages/spectrocloud-docs-internal/tests/admonitions/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/admonitions/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Admonitions = YES \ No newline at end of file +spectrocloud-docs-internal.admonitions = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/brand/.vale.ini b/packages/spectrocloud-docs-internal/tests/brand/.vale.ini index 7f199c8..eb6e602 100644 --- a/packages/spectrocloud-docs-internal/tests/brand/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/brand/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Brand = YES \ No newline at end of file +spectrocloud-docs-internal.brand = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/colon/.vale.ini b/packages/spectrocloud-docs-internal/tests/colon/.vale.ini index e93f59c..df26754 100644 --- a/packages/spectrocloud-docs-internal/tests/colon/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/colon/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Colon = YES \ No newline at end of file +spectrocloud-docs-internal.colon = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/condescending/.vale.ini b/packages/spectrocloud-docs-internal/tests/condescending/.vale.ini index 42c4250..f3c33e0 100644 --- a/packages/spectrocloud-docs-internal/tests/condescending/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/condescending/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Condescending = YES +spectrocloud-docs-internal.condescending = YES diff --git a/packages/spectrocloud-docs-internal/tests/direction/.vale.ini b/packages/spectrocloud-docs-internal/tests/direction/.vale.ini index 992039b..e84c56e 100644 --- a/packages/spectrocloud-docs-internal/tests/direction/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/direction/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Direction = YES \ No newline at end of file +spectrocloud-docs-internal.direction = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/file-type/.vale.ini b/packages/spectrocloud-docs-internal/tests/file-type/.vale.ini index 46fa95c..50d1506 100644 --- a/packages/spectrocloud-docs-internal/tests/file-type/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/file-type/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.File-Type = YES +spectrocloud-docs-internal.file-type = YES diff --git a/packages/spectrocloud-docs-internal/tests/future/.vale.ini b/packages/spectrocloud-docs-internal/tests/future/.vale.ini index 327d4fc..3f59268 100644 --- a/packages/spectrocloud-docs-internal/tests/future/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/future/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Future = YES \ No newline at end of file +spectrocloud-docs-internal.future = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/gender/.vale.ini b/packages/spectrocloud-docs-internal/tests/gender/.vale.ini index a81f480..1005e30 100644 --- a/packages/spectrocloud-docs-internal/tests/gender/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/gender/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Gender = YES \ No newline at end of file +spectrocloud-docs-internal.gender = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/headings-title/.vale.ini b/packages/spectrocloud-docs-internal/tests/headings-title/.vale.ini index a86b9da..f0196ea 100644 --- a/packages/spectrocloud-docs-internal/tests/headings-title/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/headings-title/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Headings-Title = YES \ No newline at end of file +spectrocloud-docs-internal.headings-title = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/inclusive/.vale.ini b/packages/spectrocloud-docs-internal/tests/inclusive/.vale.ini index 7b6d2b9..3edea11 100644 --- a/packages/spectrocloud-docs-internal/tests/inclusive/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/inclusive/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Inclusive = YES \ No newline at end of file +spectrocloud-docs-internal.inclusive = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/longform/.vale.ini b/packages/spectrocloud-docs-internal/tests/longform/.vale.ini index 1f638ff..d7c20d3 100644 --- a/packages/spectrocloud-docs-internal/tests/longform/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/longform/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Longform = YES \ No newline at end of file +spectrocloud-docs-internal.longform = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/oxford-comma/.vale.ini b/packages/spectrocloud-docs-internal/tests/oxford-comma/.vale.ini index 3392266..f647913 100644 --- a/packages/spectrocloud-docs-internal/tests/oxford-comma/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/oxford-comma/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Oxford-Comma = YES \ No newline at end of file +spectrocloud-docs-internal.oxford-comma = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/plural-parantheses/.vale.ini b/packages/spectrocloud-docs-internal/tests/plural-parantheses/.vale.ini index cb64237..3db9a10 100644 --- a/packages/spectrocloud-docs-internal/tests/plural-parantheses/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/plural-parantheses/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Plural-Parantheses = YES \ No newline at end of file +spectrocloud-docs-internal.plural-parantheses = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/product-ui/.vale.ini b/packages/spectrocloud-docs-internal/tests/product-ui/.vale.ini index bfd80fa..faf3ddf 100644 --- a/packages/spectrocloud-docs-internal/tests/product-ui/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/product-ui/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.Product-UI = YES \ No newline at end of file +spectrocloud-docs-internal.product-ui = YES \ No newline at end of file diff --git a/packages/spectrocloud-docs-internal/tests/we/.vale.ini b/packages/spectrocloud-docs-internal/tests/we/.vale.ini index 2b4eeb7..d320c37 100644 --- a/packages/spectrocloud-docs-internal/tests/we/.vale.ini +++ b/packages/spectrocloud-docs-internal/tests/we/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud-docs-internal.We = YES \ No newline at end of file +spectrocloud-docs-internal.we = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/colon/.vale.ini b/packages/spectrocloud/tests/colon/.vale.ini index 6e7699a..a3dff66 100644 --- a/packages/spectrocloud/tests/colon/.vale.ini +++ b/packages/spectrocloud/tests/colon/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.Colon = YES \ No newline at end of file +spectrocloud.colon = YES \ No newline at end of file diff --git a/packages/spectrocloud/tests/we/.vale.ini b/packages/spectrocloud/tests/we/.vale.ini index 266f33e..db64458 100644 --- a/packages/spectrocloud/tests/we/.vale.ini +++ b/packages/spectrocloud/tests/we/.vale.ini @@ -1,4 +1,4 @@ StylesPath = ../../styles/ MinAlertLevel = suggestion [*.md] -spectrocloud.We = YES \ No newline at end of file +spectrocloud.we = YES \ No newline at end of file From e8567aa34b9b30c6eb14e7d6f7f9edca8ffbf8a4 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 26 Jun 2024 14:32:52 -0700 Subject: [PATCH 34/34] test: all test ready --- packages/spectrocloud/tests/ableism/pass.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/spectrocloud/tests/ableism/pass.md b/packages/spectrocloud/tests/ableism/pass.md index cd3a944..cee6b73 100644 --- a/packages/spectrocloud/tests/ableism/pass.md +++ b/packages/spectrocloud/tests/ableism/pass.md @@ -6,4 +6,4 @@ You can access the cluster by issuing the following command. kubectl get pods ``` -The output displays all the pods active in the cluster. See the cluster +The output displays all the pods active in the cluster.