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.

Sign up for GitHub

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

Jump to bottom

Require an introductory paragraph in docs pages #43222

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Require an introductory paragraph in docs pages #43222

wants to merge 1 commit into from
+34 −0

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Jun 18, 2024

Add a vale rule that requires there to be a paragraph between the second frontmatter document separator (---) and the first H2-level heading of a docs page. Introductory paragraphs are common omissions in docs pages, but are important to help readers determine whether a guide is appropriate for their use case.

@github-actions GitHub Actions
Copy link

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@github-actions github-actions bot requested review from camscale and zmb3 June 18, 2024 21:12
@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch from 4e5f3e2 to 79f21f7 Compare June 24, 2024 14:52
@github-actions GitHub Actions
Copy link

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch from 79f21f7 to c5bb5fa Compare June 27, 2024 22:08
@github-actions GitHub Actions
Copy link

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch from c5bb5fa to ff07826 Compare July 9, 2024 21:06
@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 9, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch from ff07826 to 6217c60 Compare July 22, 2024 19:47
@github-actions GitHub Actions
Copy link

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch from 6217c60 to f4cde12 Compare July 22, 2024 22:01
@github-actions GitHub Actions
Copy link

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@ptgott ptgott mentioned this pull request Jul 22, 2024
Open
@ptgott ptgott added the no-changelog Indicates that a PR does not require a changelog entry label Jul 29, 2024
@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch 3 times, most recently from dfa1559 to d26dd16 Compare August 2, 2024 20:23
@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch 2 times, most recently from 7514af8 to 1544df5 Compare August 12, 2024 21:46
@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch 2 times, most recently from 0c08c06 to 6663378 Compare August 15, 2024 12:19
@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch 3 times, most recently from 63ee403 to 7c6cb17 Compare September 4, 2024 13:33
@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch 4 times, most recently from dd5bdb9 to 9f8bb8d Compare September 16, 2024 18:57
@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch 2 times, most recently from 9a31d76 to d93c551 Compare September 19, 2024 20:44
@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch 2 times, most recently from 7d221d7 to 24c435c Compare October 1, 2024 20:39
@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch from 24c435c to 6dbbde7 Compare October 7, 2024 13:40
@ptgott
Require an introductory paragraph in docs pages
e0ba9e1 
Add a vale rule that requires there to be a paragraph between the second
frontmatter document separator (`---`) and the first H2-level heading of
a docs page. Introductory paragraphs are common omissions in docs pages,
but are important to help readers determine whether a guide is
appropriate for their use case.
@ptgott ptgott force-pushed the paul.gottschling/2024-06-18-intro branch from 6dbbde7 to e0ba9e1 Compare October 17, 2024 15:21
@github-actions GitHub Actions
Copy link

🤖 Vercel preview here: https://docs-kezdogbvy-goteleport.vercel.app/docs/ver/preview

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@camscale camscale Awaiting requested review from camscale

@zmb3 zmb3 Awaiting requested review from zmb3

@mmcallister mmcallister Awaiting requested review from mmcallister

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
no-changelog Indicates that a PR does not require a changelog entry size/sm
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ptgott