-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Take a more text-based approach to docs content #15061
Labels
Comments
Need to come up with a more focused list of objectives, otherwise this issue will be outstanding forever. |
ptgott
added a commit
to gravitational/docs
that referenced
this issue
May 31, 2024
Closes gravitational/teleport#15061 We want to encourage a more textual approach to the docs. Add this as a general goal to the style guide. If ther eare specific violations of this style suggestion that we want to address with documentation efforts, linters, etc., we can plan these separately.
ptgott
added a commit
to gravitational/docs
that referenced
this issue
Jun 3, 2024
Closes gravitational/teleport#15061 We want to encourage a more textual approach to the docs. Add this as a general goal to the style guide. If ther eare specific violations of this style suggestion that we want to address with documentation efforts, linters, etc., we can plan these separately.
travelton
pushed a commit
to gravitational/docs
that referenced
this issue
Aug 26, 2024
Closes gravitational/teleport#15061 We want to encourage a more textual approach to the docs. Add this as a general goal to the style guide. If ther eare specific violations of this style suggestion that we want to address with documentation efforts, linters, etc., we can plan these separately.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Details
Let's edit the content of the docs in this repo to carry out this plan to make the docs more text oriented, i.e., more akin to a book. On the docs content side, we can start by:
Tile
s from menu pagesAdmonition
s,Notice
s andDetails
boxesWe can also consider making more radical changes that will require work in
gravitational/docs
. We can use two book-like docs sites as models: the Postgres docs and the Django docs:Category
The text was updated successfully, but these errors were encountered: