Commit Graph
7 Commits
Author SHA1 Message Date
Steven Martin e9bd3e78c6 Spelling fixes additional (#14823) 2022-07-25 14:41:34 +00:00
0fcaf92d25 Fix resource links (#12840)
* Fix resource links

Fixes #12839

Some video links still refer to the outdated "/teleport/" path.
This change adds the videos these links refer to to the "img"
directory and updates the links.

Note that two of the three MDX files that are changed here do not
actually render the video. I've changed the links here anyway in
case someone uses these as a reference for the link format.

* Apply suggestions from code review

Co-authored-by: Ben Arent <ben@goteleport.com>
Co-authored-by: Roman Tkachenko <roman@goteleport.com>

Co-authored-by: Ben Arent <ben@goteleport.com>
Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2022-06-10 20:59:59 +00:00
Paul Gottschling 4138081122 Add a UI reference entry for code blocks (#12273)
We recently gave "bash" code blocks the same functionality as
"code" blocks, and I wanted to document this. I realized that there
is no documentation for code snippets in the UI reference.
2022-05-03 20:39:08 +00:00
Paul Gottschling cabfcdba60 Mention ScopedBlock in the UI reference (#11903) 2022-04-15 20:02:22 +00:00
Paul Gottschling ed7b245a0e Mention scoped Admonitions (#11804)
Since we can now adjust the visibility of Admonitions based on scope,
this change explains how the `scope` and `scopeOnly` attributes work
in the Admonition component within the docs UI reference.
2022-04-08 18:16:27 +00:00
Paul Gottschling fa1025c33a Fix docs UI reference (#11527)
The "Tabs" heading was mistakenly made an H3. This change makes it an
H2 so it appears in the table of contents.
2022-03-30 21:48:20 +00:00
Paul Gottschling 59ab788411 Make our docs guidance discoverable (#10155)
Make our docs guidance discoverable

Currently, our guidance for making docs changes is
organized into a /docs/docs page that is only accessible if
you know the URL. This change ensures that people who have not
received an informal training on docs contributions can
contribute in a way that abides by our expectations for
consistency and effectiveness.

- Splits the docs/docs and docs/docs/best-practices pages into
  a UI reference, getting started guide, and style guide. This
  ensures that each kind of content we have in our contributing
  guide (i.e., tutorial or reference) is accessible from the
  main nav menu.
- Adds a "Contributing" tab to the navigation menu. There is
  one subsection here related to documenation, and we can add
  another subsection later with developer guides for editing
  Teleport's code.
- Moves the "philosophy" section into the intro page of the
  documentation contribution section menu.
- Makes various edits to the original docs guidance for clarity.
- Document our docs labels in a dedicated "creating an issue"
  page

Fixes #9538
2022-02-09 16:15:49 -05:00