[Rolfe] Here are my updates on the 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 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 that runs Vale against any modified files. (Check it out here under the Actions tab.
What I'm doing next:
- 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 the repository.
- Reviewing the GitHub Action I added.
- Refining the README.md content.
- 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. Feel free to discuss them here and open issues and enhancement requests on https://github.com/redhat-documentation/vale-at-red-hat/issues
- Become a contributor to the repository, particularly its styles.
Today, I added a GitHub action to run Vale against this repository. The action consists of a .github/workflows/main.yml
file. Currently, the action is configured to check new and modified files, not all files in this repository. To see the actions, look at this repository in GitHub and click the Actions tab.
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. - Adding a "Troubleshooting common errors" topic to help newcomers identify and correct common issues.
I'm also adding this blog page.