Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 13 commits into from
May 14, 2024
Merged

Conversation

plaindocs
Copy link
Contributor

@plaindocs plaindocs commented Apr 11, 2024

Which admittedly, is mostly me protecting me from myself.

These don't work when posts get mailed out, so let's make sure we don't use them.

This adds a new Vale config (and edits the existing two to tell them not use the new rule)


📚 Documentation preview 📚: https://writethedocs-www--2133.org.readthedocs.build/

@plaindocs
Copy link
Contributor Author

plaindocs commented Apr 11, 2024

Oh how tedious, looks like you can't wildcard

Opened an issue in errata-ai/vale-action#123

@plaindocs plaindocs mentioned this pull request May 3, 2024
@CollierCZ
Copy link
Member

The issue is definitely in the GitHub action. Opened errata-ai/vale-action#125, which might help.

@plaindocs
Copy link
Contributor Author

Ooh nice! You closed it though?

Move files to vale config

Co-authored-by: Aaron Collier <aaron@collier.cz>
@plaindocs
Copy link
Contributor Author

plaindocs commented May 11, 2024

OK, so that works locally

❯ vale --config=vale/news.ini --glob='docs/conf/**/news/*' *

 docs/conf/portland/2024/news/announcing-writing-day-projects.rst
 16:4  error  Don't use in-page TOC in        WTD.contents 
              newsletter posts                             

✖ 1 error, 0 warnings and 0 suggestions in 180 files.

And the actions is calling vale --output=/home/runner/work/_actions/errata-ai/vale-action/reviewdog/lib/rdjsonl.tmpl --config=vale/news.ini --glob='docs/conf/**/news/*' . over in https://github.com/writethedocs/www/actions/runs/9032315561/job/24820266130?pr=2133#step:5:40

And the . doesn't work locally where there * does :-D

wtd on  no-more-contents [$] via 🐍 v3.12.3 took 27s 
❯ vale --config=vale/news.ini --glob='docs/conf/**/news/*' .
stat .venv/bin/python: no such file or directory

wtd on  no-more-contents [$] via 🐍 v3.12.3 took 49s 
❯ vale --config=vale/news.ini --glob='docs/conf/**/news/*' *

 docs/conf/portland/2024/news/announcing-writing-day-projects.rst
 16:4  error  Don't use in-page TOC in        WTD.contents 
              newsletter posts                             

✖ 1 error, 0 warnings and 0 suggestions in 180 files.

@CollierCZ
Copy link
Member

Both * and . work on the Mac I'm currently using. I'd guess that might not be fully OS-independent. Maybe if we try specifying a folder.

Co-authored-by: Aaron Collier <aaron@collier.cz>
.github/workflows/main.yml Outdated Show resolved Hide resolved
.github/workflows/main.yml Outdated Show resolved Hide resolved
@CollierCZ
Copy link
Member

Ah, that was it. Removing the quotes, as suggested in errata-ai/vale-action#83

@plaindocs
Copy link
Contributor Author

Quite the adventure!

.github/workflows/main.yml Outdated Show resolved Hide resolved
Co-authored-by: Aaron Collier <aaron@collier.cz>
@plaindocs plaindocs enabled auto-merge (squash) May 14, 2024 11:01
@plaindocs plaindocs merged commit def67ff into main May 14, 2024
7 checks passed
@plaindocs plaindocs deleted the no-more-contents branch May 14, 2024 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants