Add intro paragraphs to docs pages #48513
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
requested review from
greedy52,
hugoShaka,
mmcallister,
nklaassen,
r0mant,
strideynet,
timothyb89,
xinding33 and
zmb3
|
🤖 Vercel preview here: https://docs-47ytw7jbr-goteleport.vercel.app/docs/ver/preview |
ptgott
added
no-changelog
ptgott
force-pushed
the
paul.gottschling/44532-intros
branch
from
89ef4db
to
68b4f63
Compare
|
🤖 Vercel preview here: https://docs-90xqzdy4t-goteleport.vercel.app/docs/ver/preview |
strideynet
approved these changes
Nov 7, 2024
ptgott
force-pushed
the
paul.gottschling/44532-intros
branch
from
68b4f63
to
ceb7a43
Compare
|
🤖 Vercel preview here: https://docs-l7g4d01zl-goteleport.vercel.app/docs/ver/preview |
greedy52
approved these changes
Nov 8, 2024
public-teleport-github-review-bot
bot
removed request for
r0mant,
timothyb89,
mmcallister and
zmb3
public-teleport-github-review-bot
bot
removed request for
hugoShaka,
nklaassen and
xinding33
Closes #44532 Ensure that all docs pages include an introductory paragraph, which spells out the scope of a page and indicates to a reader whether the page is appropriate for their needs. In some pages, the "How it works" section functions like an introductory paragraph. In these cases, turn the "How it works" section into an introductory paragraph and add a new "How it works" section. Other pages already include an introductory paragraph with the H2 "Introduction". Standardize the docs on not including a heading before the introductory paragraph.
ptgott
force-pushed
the
paul.gottschling/44532-intros
branch
from
ceb7a43
to
fbc32f9
Compare
|
@greedy52 To satisfy the prose linter, I added a "How it works" section to the MySQL auto user provisioning guide (diff on GitHub). Just checking if that looks okay before I merge. Thanks! |
|
🤖 Vercel preview here: https://docs-eoxg8vigy-goteleport.vercel.app/docs/ver/preview |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #44532
Ensure that all docs pages include an introductory paragraph, which spells out the scope of a page and indicates to a reader whether the page is appropriate for their needs.
In some pages, the "How it works" section functions like an introductory paragraph. In these cases, turn the "How it works" section into an introductory paragraph and add a new "How it works" section.
Other pages already include an introductory paragraph with the H2 "Introduction". Standardize the docs on not including a heading before the introductory paragraph.