No more in-page table of contents in blog posts (#2133)

* No more in-page table of contents in blog posts * Quote the wildcards * Try later Vale release * Update .github/workflows/main.yml Move files to vale config Co-authored-by: Aaron Collier <aaron@collier.cz> * Update .github/workflows/main.yml Co-authored-by: Aaron Collier <aaron@collier.cz> * Update .github/workflows/main.yml * Apply suggestions from code review * Update .github/workflows/main.yml * Test without quotes * Make tests pass * Update .github/workflows/main.yml Co-authored-by: Aaron Collier <aaron@collier.cz> --------- Co-authored-by: Aaron Collier <aaron@collier.cz>
writethedocs · May 14, 2024 · def67ff · def67ff
1 parent 053c86a
commit def67ff
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 5 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -48,6 +48,19 @@ jobs:
           filter_mode: file
           version: 3.4.2
 
+      - name: Vale Conf news Linter
+        uses: errata-ai/vale-action@reviewdog
+        env:
+          # Required, set by GitHub actions automatically:
+          # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        with:
+          files: docs
+          vale_flags: "--config=vale/news.ini --glob=docs/conf/**/news/*"
+          reporter: github-pr-check
+          fail_on_error: true
+          filter_mode: file
+          version: 3.4.2
 
   yaml-validate:
     runs-on: ubuntu-latest

diff --git a/docs/conf/portland/2024/news/announcing-writing-day-projects.rst b/docs/conf/portland/2024/news/announcing-writing-day-projects.rst
@@ -11,11 +11,7 @@ Who's ready for Writing Day?! I know of at least six project organizers who are
 
 Didn't have a moment to submit your project early? Fear not, you can `submit it at any time <https://www.writethedocs.org/conf/portland/2024/writing-day/#call-for-project-submissions>`__ between now and April 12 or you can bring it and submit it live during Writing Day. Day of project submissions are a time honored WTD tradition that we look forward to seeing continue.
 
-Get excited, get delighted, and get ready to meet our first **Writing Day projects** for Write the Docs Portland 2024:
-
-.. contents::
-   :depth: 2
-   :local:
+Get excited, get delighted, and get ready to meet our first **Writing Day projects** for Write the Docs Portland 2024.
 
 Docs as Tests & Doc Detective: Help us test your docs!
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/vale/WTD/contents.yml b/vale/WTD/contents.yml
@@ -0,0 +1,7 @@
+message: "Don't use in-page TOC in newsletter posts"
+extends: existence
+ignorecase: true
+level: error
+scope: raw
+raw:
+  - 'contents::'
diff --git a/vale/guide.ini b/vale/guide.ini
@@ -10,4 +10,6 @@ WTD.inclusivity-avoid = YES
 WTD.inclusivity = YES
 WTD.branding = YES
 
+WTD.contents = NO
+
 proselint.GenderBias = YES
diff --git a/vale/news.ini b/vale/news.ini
@@ -0,0 +1,6 @@
+StylesPath = .
+MinAlertLevel = warning
+
+[*.rst]
+
+WTD.contents = YES
diff --git a/vale/vale.ini b/vale/vale.ini
@@ -5,6 +5,7 @@ MinAlertLevel = warning
 BasedOnStyles = WTD, proselint
 
 WTD.headings = NO
+WTD.contents = NO
 
 # Initially, some proselint styles were included in vale.
 # In later vale versions, those were removed, so now we include