Merge pull request #56 from themr0c/readme-migration-step-2

Author: themr0c

.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Linting with Vale
+on: [push]
+
+jobs:
+  prose:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Vale Linter
+        uses: errata-ai/[email protected]
+        with:
+          files: __onlyModified
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/vale.yml

@@ -19,3 +19,4 @@ ExternalTimeout: 60 # (seconds) default is 15.
 IgnoreURLs:
   - https://cse.google.com/cse.js
   - https://github.com/rolfedh/studious-fortnight
+  - https://marketplace.visualstudio.com

.htmltest.yml

@@ -1,2 +1,3 @@
 # Contributor's guide
 
+* See: link:https://rolfedh.github.io/studious-fortnight/docs/end-user-guide/contributing/[Contributing].

CONTRIBUTING.adoc

@@ -2,42 +2,10 @@
 
 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.
 
-## Understanding `vale` usage
+* See the documentation: link:https://rolfedh.github.io/studious-fortnight/[Vale for Red Hat documentation writers]
 
-* See: link:https://rolfedh.github.io/studious-fortnight/docs/end-user-guide/introduction/[]
-
-
-## Contributing to this project
-
-image::images/open-source-wants-you-39-percent.jpg[Open Source Wants You]
-
-You can help by doing any of the following:
-* Use Vale with the style rules from this studious-fortnight repository.
-* Report issues and request enhancements.
-* Authoring style rules.
-
-To become a contributor, see xref:CONTRIBUTING.adoc[].
-
-
-## Getting started with vale
-
-* See: link:https://rolfedh.github.io/studious-fortnight/docs/end-user-guide/getting-started-with-vale/[]
-
-
-## Optional next steps
-
-* link:https://code.visualstudio.com/docs/?dv=linux64_rpm[Install VisualStudio Code] and the link:https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server[Vale extension for VisualStudio Code].
-* link:https://docs.errata.ai/vale/install#using-vale-with-a-continuous-integration-ci-service[Add Vale to your docs continuous integration (CI) service].
-* link:https://github.com/errata-ai/vale-action[Add Vale to your GitHub actions].
-
-## Related topics
+.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]
-
-## How to get involved, get help, and contribute
-
-* Join the Slack channel, link:https://coreos.slack.com/archives/C0218RXJK5E[#vale-at-red-hat], in the CoreOS workspace.
-* To report a bug _in this repository_ or request an enhancement, link:https://github.com/rolfedh/studious-fortnight/issues[create an issue].
-* To show appreciation and support for Joseph Kato's work on Vale, consider link:https://docs.errata.ai/vale/about#sponsors[making a donation].

README.adoc

@@ -1,8 +1,10 @@
 * xref:introduction.adoc[]
 * xref:getting-started-with-vale.adoc[]
-** xref:understanding-vale-output.adoc[]
-** xref:adding-vale-configuration-to-a-project.adoc[]
+* xref:understanding-vale-output.adoc[]
+* xref::using-vale-in-the-ide.adoc[]
 * xref:defining-a-vale-onboarding-strategy.adoc[]
+* xref:adding-vale-configuration-to-a-project.adoc[]
+* xref:using-vale-with-a-continuous-integration-service.adoc[]
 * xref:contributing.adoc[]
 ** xref:extending-the-vocabulary.adoc[]
 ** xref:extending-styles.adoc[]

modules/end-user-guide/nav.adoc

@@ -1,5 +1,5 @@
 // Metadata for Antora
-:navtitle: Understanding output
+:navtitle: Understanding Vale alerts
 :keywords: understanding, output
 // :page-aliases: 
 // End of metadata for Antor
@@ -13,6 +13,6 @@
 :context: understanding-vale-output
 
 
-include::partial$con_understanding-vale-output.adoc[leveloffest=+1]
+include::partial$con_understanding-vale-output.adoc[leveloffset=+1]
 
 :context: {parent-context-of-understanding-vale-output}

modules/end-user-guide/pages/understanding-vale-output.adoc

@@ -0,0 +1,17 @@
+// Metadata for Antora
+:navtitle: Vale in the IDE
+:keywords: vale
+// :page-aliases: 
+// End of metadata for Antora
+
+:parent-context-of-using-vale-in-the-ide: {context}
+
+[id="using-vale-in-the-ide_{context}"]
+= Using vale in the IDE
+
+:context: using-vale-in-the-ide
+
+include::partial$proc_using-vale-in-the-ide.adoc[leveloffset=+1]
+
+
+:context: {parent-context-of-using-vale-in-the-ide}

modules/end-user-guide/pages/using-vale-in-the-ide.adoc

@@ -0,0 +1,19 @@
+// Metadata for Antora
+:navtitle: Continuous integration
+:keywords: vale
+// :page-aliases: 
+// End of metadata for Antora
+
+:parent-context-of-using-vale-with-a-continuous-integration-service: {context}
+
+[id="using-vale-with-a-continuous-integration-service_{context}"]
+= Using vale with a continuous integration service
+
+:context: using-vale-with-a-continuous-integration-service
+
+include::partial$proc_using-vale-github-action.adoc[leveloffset=+1]
+
+include::partial$proc_using-vale-with-a-continuous-integration-service.adoc[leveloffset=+1]
+
+
+:context: {parent-context-of-using-vale-with-a-continuous-integration-service}

modules/end-user-guide/pages/using-vale-with-a-continuous-integration-service.adoc

@@ -0,0 +1,40 @@
+:_module-type: PROCEDURE
+
+[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.
+
+.Prerequisites
+
+* xref:getting-started-with-vale.adoc[]
+* xref:adding-vale-configuration-to-a-project.adoc[]
+* xref:defining-a-vale-onboarding-strategy.adoc[]
+
+.Procedure
+
+* Add a `.github/workflows/vale.yml` file to your repository with following content:
++
+[source,yaml]
+----
+name: Linting with Vale
+on: [push]
+
+jobs:
+  prose:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Vale Linter
+        uses: errata-ai/[email protected]
+        with:
+          files: __onlyModified
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+----
+
+.Additional resources
+
+* link:https://github.com/errata-ai/vale-action[Vale GitHub action].