Merge pull request #60 from themr0c/fix-release-yaml

.github/ISSUE_TEMPLATE/bug_report.md

@@ -10,29 +10,19 @@ assignees: ''
 **Describe the bug**
 A clear and concise description of what the bug is.
 
+Examples:
+
+* This word or expression triggers an illegitimate vale alert.
+* This word or expression triggers an ambiguous vale alert.
+
 **To Reproduce**
 Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '...'
-3. Scroll down to '...'
-4. See the error
+
+1. Add this word or expression:
+2. Vale reports an illegitimate alert: error, warning, suggestion.
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (complete the following information):**
- - Operating system: [for example iOS]
- - Browser [for example chrome, safari]
- - Version [for example 22]
-
-**Smartphone (complete the following information):**
- - Device: [for example iPhone6]
- - Operating system: [for example iOS8.1]
- - Browser [for example stock browser, safari]
- - Version [for example 22]
-
 **Additional context**
-Add any other context about the problem here.
+Add any other context here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -8,13 +8,13 @@ assignees: ''
 ---
 
 **Is your feature request related to a problem? Describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+A clear and concise description of what the problem is.
 
-**Describe the solution you'd like**
+**Describe the solution you'd propose**
 A clear and concise description of what you want to happen.
 
 **Describe alternatives you've considered**
 A clear and concise description of any alternative solutions or features you've considered.
 
 **Additional context**
-Add any other context or screenshots about the feature request here.
+Add any other context or screenshots here.

.github/workflows/try-in-web-ide.yaml → .github/workflows/add-web-ide-link.yaml

@@ -7,15 +7,16 @@
 #
 # SPDX-License-Identifier: EPL-2.0
 #
-# Add Web IDE link on PRs
-name: web-ide
-
+# Add Web IDE link on pull requests
+name: Add Web IDE link
 on:
   pull_request_target:
-    types: [opened, synchronize]
-
+    types:
+      - opened
+      - synchronize
 jobs:
   add-link:
+    name: Add Web IDE link
     runs-on: ubuntu-20.04
     steps:
       - name: Web IDE Pull Request Check

.github/workflows/build-and-publish-to-github-pages.yaml

@@ -14,9 +14,11 @@
 name: Publish to GitHub Pages
 on:
   push:
-    branches: [main]
+    branches:
+      - main
 jobs:
-  build:
+  publish:
+    name: Publish to GitHub Pages
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository

.github/workflows/build-and-validate-on-pr.yaml

@@ -9,14 +9,12 @@
 #
 
 # Name is reused in `publish-netlify.yml`
-name: "Build and validate pull request"
-
+name: Build and validate pull request
 on:
   - pull_request
-
 jobs:
   build:
-    name: "Build and validate pull request"
+    name: Build and validate pull request
     runs-on: ubuntu-20.04
     container: "quay.io/eclipse/che-docs:latest"
     steps:
@@ -28,38 +26,32 @@ jobs:
       - name: Build using antora # and fail on warning
         id: antora-build
         run: CI=true antora generate antora-playbook-for-development.yml --stacktrace 2>&1 | (tee | grep  WARNING && exit 42 || exit 0)
-
       - name: Upload artifact doc-content
         uses: actions/upload-artifact@v2
         with:
           name: doc-content
           path: build/site
-
       - name: Store PR info for publish-netlify
         run: |
           echo "${{ github.event.number }}" > PR_NUMBER
           echo "${{ github.event.pull_request.head.sha }}" > PR_SHA
-
       - name: Upload artifact pull-request-number for publish-netlify
         uses: actions/upload-artifact@v2
         with:
           name: pull-request-number
           path: PR_NUMBER
-
       - name: Upload artifact pull-request-sha for publish-netlify
         uses: actions/upload-artifact@v2
         with:
           name: pull-request-sha
           path: PR_SHA
-
       - name: Cache htmltest status code of checked external URLs # See: https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows
         uses: actions/cache@v2
         env:
           cache-name: cache-htmltest
         with:
           key: refcache.json
           path: .cache/htmltest
-
       - name: Validate links using htmltest
         id: validate-links
         run: htmltest

.github/workflows/build-and-validate-on-push.yaml

@@ -11,38 +11,34 @@
 # GitHub Actions configuration file for htmltest
 # See: https://github.com/wjdp/htmltest
 
-name: Build and validate
+name: Build and validate on push
 on:
   - push
 jobs:
   build:
-    name: Build and validate
+    name: Build and validate on push
     runs-on: ubuntu-20.04
     container: "quay.io/eclipse/che-docs:latest"
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
-
       - name: Build using antora
         id: antora-build
         run: CI=true antora generate antora-playbook-for-development.yml --stacktrace
-
       - name: Upload artifact
         uses: actions/upload-artifact@v2
         with:
           name: doc-content
           path: build/site
-
       - name: Cache htmltest status code of checked external URLs # See: https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows
         uses: actions/cache@v2
         env:
           cache-name: cache-htmltest
         with:
           key: refcache.json
           path: .cache/htmltest
-
       - name: Validate links using htmltest
         id: validate-links
         run: htmltest

.github/workflows/publish-netlify.yml

@@ -10,15 +10,13 @@
 
 # NOTE: Because this worklow is using secrets, it cannot run directly on a pull-request workflow, which is running in the context of the forked repository.
 
-name: Publish doc-content using netlify
-
+name: Publish pull request doc-content using netlify
 on:
   workflow_run:
     workflows:
       - "Build and validate pull request"
     types:
       - completed
-
 jobs:
   publish:
     name: Publish doc-content using netlify

.github/workflows/release.yml

@@ -1,10 +1,20 @@
+---
+#
+# Copyright (c) 2021 Red Hat, Inc.
+# This program and the accompanying materials are made
+# available under the terms of the Eclipse Public License 2.0
+# which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+#
 name: Release
 on:
   push:
     branches:
       - main
 jobs:
-  prose:
+  release:
+    name: Release
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

.github/workflows/vale.yml

@@ -1,14 +1,23 @@
+---
+#
+# Copyright (c) 2021 Red Hat, Inc.
+# This program and the accompanying materials are made
+# available under the terms of the Eclipse Public License 2.0
+# which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+#
 name: Linting with Vale
 on:
   - pull_request
   - push
 jobs:
-  prose:
+  vale:
+    name: Linting with Vale
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@master
-
       - name: Vale Linter
         uses: errata-ai/[email protected]
         with:

.vale.ini

@@ -32,7 +32,9 @@ SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock,
 properties = md
 
 # Match AsciiDoc files. See: https://docs.errata.ai/vale/scoping
-[*.adoc]
+# Ignore files in a directory starting by `.` 
+# to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
+[[!.]*.adoc]
 # Styles to load, located in the `StylesPath` folder:
 BasedOnStyles = RedHat
 

.vale/styles/RedHat/README-IBM.adoc

@@ -0,0 +1,9 @@
+= README for Rules from the IBM Style Guide
+
+All rights for the IBM Style Guide belong to IBM.
+
+Our sources of inspiration:
+
+* link:https://github.com/errata-ai/IBM[The primary Vale implementation of the IBM Style Guide]
+
+* https://www.ibm.com/developerworks/library/styleguidelines/index.html[The DeveloperWorks version of the IBM Style Guide]

.vale/styles/RedHat/README-write-good.md

@@ -1,3 +1,4 @@
+<!-- vale off -->
 Based on [write-good](https://github.com/btford/write-good).
 
 > Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too.

README.adoc

@@ -1,6 +1,6 @@
 # Studious-fortnight repository
 
-This repository helps tech writers at Red Hat get up and running with Vale. It serves as the starting point for the Vale Community of Practice at Red Hat.
+This repository helps tech writers at Red Hat get up and running with Vale. It is the starting point for the Vale Community of Practice at Red Hat.
 
 * See the documentation: link:https://rolfedh.github.io/studious-fortnight/[Vale for Red Hat documentation writers]
 

modules/end-user-guide/partials/proc_extending-the-spelling-rule.adoc

@@ -55,7 +55,7 @@ $ vale .
 . Vale should:
 +
 * Report no error for the new term in the `testvalid.adoc` file
-* Optionnally, report an error for the new term in the `testinvalid.adoc` file
+* Optionally, report an error for the new term in the `testinvalid.adoc` file
 
 .Additional resources
 

modules/end-user-guide/partials/proc_using-vale-github-action.adoc

@@ -3,7 +3,10 @@
 [id="proc_using-vale-github-action_{context}"]
 = Using vale GitHub Action
 
-Consider using vale GitHub Action when your repository is hosted on GitHub, to measure or enforce the project compliance with the Style Guides.
+Consider using vale GitHub Action when:
+
+* The content repository is on GitHub.
+* The goal is to measure or enforce the project compliance with the Style Guides.
 
 WARNING: Due to the GitHub token permissions, this Action can not post annotations to PRs from forked repositories.