From 081175030f0af2229c3782c61e6e883543a782a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 21 Oct 2021 16:02:03 +0200 Subject: [PATCH] chore: moving to https://github.com/vale-at-red-hat/vale-at-red-hat --- .github/workflows/vale.yml | 4 ++-- .htmltest.yml | 2 +- .vale-for-github-action.ini | 2 +- .vale.ini | 2 +- CONTRIBUTING.adoc | 2 +- README.adoc | 6 ++---- antora-playbook.yml | 4 ++-- antora.yml | 6 +++--- ...dding-vale-configuration-to-a-project.adoc | 4 ++-- .../proc_using-vale-github-action.adoc | 4 ++-- troubleshooting-common-errors.md | 4 ++-- vale-at-red-hat-blog.md | 20 +++++++++---------- 12 files changed, 29 insertions(+), 31 deletions(-) diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index 6e9acefa4..ad517c9c2 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -22,7 +22,7 @@ jobs: uses: errata-ai/vale-action@v1.4.0 with: files: __onlyModified - styles: https://github.com/rolfedh/studious-fortnight/releases/latest/download/RedHat.zip - config: https://raw.githubusercontent.com/rolfedh/studious-fortnight/master/.vale-for-github-action.ini + styles: https://github.com/vate-at-red-hat/vale-at-red-hat/releases/latest/download/RedHat.zip + config: https://raw.githubusercontent.com/vate-at-red-hat/vale-at-red-hat/master/.vale-for-github-action.ini env: GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} diff --git a/.htmltest.yml b/.htmltest.yml index 721d05b4f..9b64ef59a 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -18,5 +18,5 @@ CacheExpires: "12h" # Default is 2 weeks. ExternalTimeout: 60 # (seconds) default is 15. IgnoreURLs: - https://cse.google.com/cse.js - - https://github.com/rolfedh/studious-fortnight + - https://github.com/vate-at-red-hat/vale-at-red-hat - https://marketplace.visualstudio.com diff --git a/.vale-for-github-action.ini b/.vale-for-github-action.ini index 61ab07a35..53e4c4026 100644 --- a/.vale-for-github-action.ini +++ b/.vale-for-github-action.ini @@ -1,4 +1,4 @@ -# Vale configuration file for `studious-fortnight` repository. +# Vale configuration file for the `https://github.com/vate-at-red-hat/vale-at-red-hat` repository. # See: https://docs.errata.ai/vale/config # Core settings appear at the top (the "global" section). diff --git a/.vale.ini b/.vale.ini index 70db404e9..dac1c5c78 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,4 @@ -# Vale configuration file for `studious-fortnight` repository. +# Vale configuration file for the https://github.com/vate-at-red-hat/vale-at-red-hat repository. # See: https://docs.errata.ai/vale/config # Core settings appear at the top (the "global" section). diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index a7d5e161e..a8fce6b27 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -1,3 +1,3 @@ # Contributor's guide -* See: link:https://rolfedh.github.io/studious-fortnight/docs/end-user-guide/contributing/[Contributing]. \ No newline at end of file +* See: link:https://vate-at-red-hat.github.io/vale-at-red-hat/docs/end-user-guide/contributing/[Contributing]. \ No newline at end of file diff --git a/README.adoc b/README.adoc index a69bac40f..1f84b21f0 100644 --- a/README.adoc +++ b/README.adoc @@ -1,11 +1,9 @@ -# Studious-fortnight repository +# Vale at Red Hat repository 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] +* See the documentation: link:https://vate-at-red-hat.github.io/vale-at-red-hat/[Vale for Red Hat documentation writers] .Additional resources -* xref:troubleshooting-common-errors.md[Troubleshooting common errors] -* xref:vale-at-red-hat-blog.md[Blog posts for Studious-Fortnight] * xref:https://rolfe.blog/category/vale/[Rolfe's "Vale notes" blog posts] diff --git a/antora-playbook.yml b/antora-playbook.yml index fac75d164..cf7b3ecc8 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -16,7 +16,7 @@ site: title: Vale for Red Hat documentation writers # The url property is mandatory to generate the 404 and sitemap files. - url: https://rolfedh.github.io/studious-fortnight + url: https://vate-at-red-hat.github.io/vale-at-red-hat start_page: docs::index.adoc # keys: # google_analytics: "PLACEHOLDER" @@ -26,7 +26,7 @@ content: - url: ./ branches: - main - edit_url: "https://github.com/rolfedh/studious-fortnight/edit/main/{path}" + edit_url: "https://github.com/vate-at-red-hat/vale-at-red-hat/edit/main/{path}" output: clean: true ui: diff --git a/antora.yml b/antora.yml index 900c90168..5038bca66 100644 --- a/antora.yml +++ b/antora.yml @@ -26,6 +26,6 @@ asciidoc: icons: font # for the project context: docs - repository-name: studious-fortnight - repository-url: https://github.com/rolfedh/studious-fortnight - repository-clone-url: git@github.com:rolfedh/studious-fortnight.git + repository-name: vale-at-red-hat + repository-url: https://github.com/vate-at-red-hat/vale-at-red-hat + repository-clone-url: git@github.com:vate-at-red-hat/vale-at-red-hat.git diff --git a/modules/end-user-guide/partials/proc_adding-vale-configuration-to-a-project.adoc b/modules/end-user-guide/partials/proc_adding-vale-configuration-to-a-project.adoc index d5683931e..8cd8baba9 100644 --- a/modules/end-user-guide/partials/proc_adding-vale-configuration-to-a-project.adoc +++ b/modules/end-user-guide/partials/proc_adding-vale-configuration-to-a-project.adoc @@ -17,9 +17,9 @@ Consider adding vale configuration files to a project to: .Procedure -. Download the link:{repository-url}/archive/refs/heads/main.zip[studious-fortnight ZIP archive] and decompress it to your local environment. +. Download the link:{repository-url}/archive/refs/heads/main.zip[{repository-name} ZIP archive] and decompress it to your local environment. -. Copy the `.vale.ini` file and `.vale` directory from the `studious-fortnight` directory to the `____` directory containing your documentation project. +. Copy the `.vale.ini` file and `.vale` directory from the `{repository-name}` directory to the `____` directory containing your documentation project. + [subs="+quotes,+attributes"] ---- diff --git a/modules/end-user-guide/partials/proc_using-vale-github-action.adoc b/modules/end-user-guide/partials/proc_using-vale-github-action.adoc index e21400871..ad9c472ac 100644 --- a/modules/end-user-guide/partials/proc_using-vale-github-action.adoc +++ b/modules/end-user-guide/partials/proc_using-vale-github-action.adoc @@ -37,8 +37,8 @@ jobs: uses: errata-ai/vale-action@v1.4.0 with: files: __onlyModified - styles: https://github.com/rolfedh/studious-fortnight/releases/latest/download/RedHat.zip - config: https://raw.githubusercontent.com/rolfedh/studious-fortnight/master/.vale-for-github-action.ini + styles: https://github.com/vate-at-red-hat/vale-at-red-hat/releases/latest/download/RedHat.zip + config: https://raw.githubusercontent.com/vate-at-red-hat/vale-at-red-hat/master/.vale-for-github-action.ini env: GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} ---- diff --git a/troubleshooting-common-errors.md b/troubleshooting-common-errors.md index 70536902f..ec079297e 100644 --- a/troubleshooting-common-errors.md +++ b/troubleshooting-common-errors.md @@ -4,7 +4,7 @@ For example: ``` -[rolfedh@fedora-desktop openshift-docs]$ vale cluster-logging-forwarding-about.adoc +$ vale cluster-logging-forwarding-about.adoc stdin.txt 1:34 error Did you really mean 'adoc'? Vale.Spelling @@ -14,6 +14,6 @@ For example: This error happened because you made a mistake when you specified the file path or file name. When you specify the file correctly, the error disappears. For example: ``` -[rolfedh@fedora-desktop openshift-docs]$ vale modules/cluster-logging-forwarding-about.adoc +$ vale modules/cluster-logging-forwarding-about.adoc ✔ 0 errors, 0 warnings and 0 suggestions in 1 file. ``` diff --git a/vale-at-red-hat-blog.md b/vale-at-red-hat-blog.md index 3f2c4f130..96b5adc3b 100644 --- a/vale-at-red-hat-blog.md +++ b/vale-at-red-hat-blog.md @@ -2,27 +2,27 @@ ## 21. May, 14:12, Friday -[Rolfe] Here are my updates on studious-fortnight. +[Rolfe] Here are my updates on the repository. -**Goal**: To make studious-fortnight become a "Vale at Red Hat" repository worth moving over to the Red Hat doc tools repository. +**Goal**: To make the repository become a "Vale at Red Hat" repository worth moving over to the Red Hat doc tools repository. **What I've done recently**: -- I updated the studious' with the Vale style from the Che eclipse documentation project that Yana and Fabrice developed. +- I updated the repository with the Vale style from the Che eclipse documentation project that Yana and Fabrice developed. - I've been welcoming new team members to this channel. - I hosted the "Friday 15 for Vale" at Red Hat. -- I added a GitHub Action to studious' that runs Vale against any modified files. (Check it out [here under the Actions tab](https://github.com/rolfedh/studious-fortnight/actions). +- I added a GitHub Action that runs Vale against any modified files. (Check it out [here under the Actions tab](https://github.com/vate-at-red-hat/vale-at-red-hat/actions). **What I'm doing next**: -- Running the studious' Vale style against some of my product docs. +- Running the Vale style against some of my product docs. - Refining the style rules and vocabulary to reduce false positives. -- Adding a "project" topic to studious'. +- Adding a "project" topic to the repository. - Reviewing the GitHub Action I added. - Refining the README.md content. -- Set up studious' permissions for contributors and add a `contributors.md` topic. +- Set up permissions for contributors and add a `contributors.md` topic. **Any needs or blockers**? -- I'd appreciate your notes on getting started with Vale and studious'. Feel free to discuss them here and open issues and enhancement requests on https://github.com/rolfedh/studious-fortnight/issues -- Become a contributor to studious, particularly its styles. +- I'd appreciate your notes on getting started with Vale. Feel free to discuss them here and open issues and enhancement requests on https://github.com/vate-at-red-hat/vale-at-red-hat/issues +- Become a contributor to the repository, particularly its styles. ## 19. May, 7:37 AM, Wednesday @@ -31,7 +31,7 @@ Today, I added a _GitHub action_ to run Vale against this repository. The action ## 16. May, 1:22 PM, Sunday -Rolfe: This weekend, I merged many updates into the studious-fortnight repository. These included: +Rolfe: This weekend, I merged many updates into the repository. These included: - Removing the previous `/styles` folder and `.vale.ini` file. - Adding the `.vale` styles folder and `.vale.ini` that Fabrice and Yana developed for the Che eclipse documentation project. - Updating and expanding `README.md` with new information to help you get started with using Vale.