diff --git a/.github/workflows/style-guide.yml b/.github/workflows/style-guide.yml new file mode 100644 index 0000000000..509d3dbc44 --- /dev/null +++ b/.github/workflows/style-guide.yml @@ -0,0 +1,22 @@ +--- +name: Verify style guide compliance on pull request +on: [pull_request] + +jobs: + vale: + name: Linting with Vale + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Install Asciidoctor + run: sudo apt-get install -y asciidoctor + - name: Run Vale on new and modified content + uses: errata-ai/vale-action@v2.1.1 + with: + files: assemblies + vale_flags: "--minAlertLevel=warning" + reporter: github-pr-review + env: + GITHUB_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }} + REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }} diff --git a/.gitignore b/.gitignore index 483e61755e..cbacf51e7a 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,6 @@ titles/*/build index.html titles-generated/ -.vale.ini .vale-styles/RedHat .vscode .cache/ diff --git a/.vale-styles/DeveloperHub/tests/.vale.ini b/.vale-styles/DeveloperHub/tests/.vale.ini new file mode 100644 index 0000000000..7b925bbc13 --- /dev/null +++ b/.vale-styles/DeveloperHub/tests/.vale.ini @@ -0,0 +1,12 @@ +; .vale.ini +; Specifies Vale configuration +; See: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/installing-vale-cli/ +; +; Download and search Vale styles in this directory: +StylesPath = ../.. +; Minimum alert level to display: +MinAlertLevel = suggestion +; Display alerts on AsciiDoc files: +[*.adoc] +; Apply these styles: +BasedOnStyles = DeveloperHub diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000000..b3e6e7a295 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,18 @@ +# .vale.ini +# Specifies Vale configuration +# See: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/installing-vale-cli/ +# + +# Download and search Vale styles in this directory: +StylesPath = ".vale-styles" + +# Minimum alert level to display: +MinAlertLevel = suggestion + +# Styles to download: +Packages = RedHat + +# Display alerts on AsciiDoc files: +[*.adoc] +# Apply these styles: +BasedOnStyles = RedHat,DeveloperHub diff --git a/assemblies/images b/assemblies/images deleted file mode 120000 index 5fa6987088..0000000000 --- a/assemblies/images +++ /dev/null @@ -1 +0,0 @@ -../../images \ No newline at end of file diff --git a/titles/plugin-rhdh/admin b/titles/plugin-rhdh/admin deleted file mode 120000 index 87a6c0d621..0000000000 --- a/titles/plugin-rhdh/admin +++ /dev/null @@ -1 +0,0 @@ -../../admin \ No newline at end of file diff --git a/titles/plugin-rhdh/getting-started b/titles/plugin-rhdh/getting-started deleted file mode 120000 index 557f806d93..0000000000 --- a/titles/plugin-rhdh/getting-started +++ /dev/null @@ -1 +0,0 @@ -../../getting-started \ No newline at end of file diff --git a/titles/plugin-rhdh/installation b/titles/plugin-rhdh/installation deleted file mode 120000 index 863ed577be..0000000000 --- a/titles/plugin-rhdh/installation +++ /dev/null @@ -1 +0,0 @@ -../../installation \ No newline at end of file