Skip to content

Commit

Permalink
Merge pull request #61 from themr0c/moving-the-repository
Browse files Browse the repository at this point in the history
  • Loading branch information
themr0c authored Oct 21, 2021
2 parents 3e31cf2 + 0811750 commit 17cdfe0
Show file tree
Hide file tree
Showing 12 changed files with 29 additions and 31 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/vale.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
uses: errata-ai/[email protected]
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}}
2 changes: 1 addition & 1 deletion .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion .vale-for-github-action.ini
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
2 changes: 1 addition & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Contributor's guide

* See: link:https://rolfedh.github.io/studious-fortnight/docs/end-user-guide/contributing/[Contributing].
* See: link:https://vate-at-red-hat.github.io/vale-at-red-hat/docs/end-user-guide/contributing/[Contributing].
6 changes: 2 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -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]
4 changes: 2 additions & 2 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: [email protected]: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: [email protected]:vate-at-red-hat/vale-at-red-hat.git
Original file line number Diff line number Diff line change
Expand Up @@ -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 `__<project_directory>__` directory containing your documentation project.
. Copy the `.vale.ini` file and `.vale` directory from the `{repository-name}` directory to the `__<project_directory>__` directory containing your documentation project.
+
[subs="+quotes,+attributes"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ jobs:
uses: errata-ai/[email protected]
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}}
----
Expand Down
4 changes: 2 additions & 2 deletions troubleshooting-common-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
```
20 changes: 10 additions & 10 deletions vale-at-red-hat-blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,27 @@
<!-- vale off -->
## 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

Expand All @@ -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.
Expand Down

0 comments on commit 17cdfe0

Please sign in to comment.