Commit Graph
10 Commits
Author SHA1 Message Date
Paul Gottschling 67391f93e7 Add a glossary of Teleport terms (#16762)
* Add a glossary of Teleport terms

Closes #16121
Closes #13363

- Create a Core Concepts page based on the Architecture Overview page.
  The Overview page is an outline of core concepts, so I thought it
  would make a good starting point for the glossary.

- Add the Core Concepts page to the Home section to make it more
  prominent for users who are visiting the docs homepage. This should
  give it more traffic than leaving it in the Architecture section.

- Move definitions out of the "Definitions" table. Since this table
  repeats content from the body sections and comes after them, it makes
  sense to condense all content into brief body sections.

- Alphabetize sections

- Bold the first instance of each keyword within a given section. Not
  adding links since these are all to the same page. It might get a bit
  confusing to click a link and not see a change in view, since the
  target section would already be on the page.

- Remove the intro paragraph of the old Overview page, since it's not
  strictly related to core concepts.

* Respond to PR feedback and add further edits

- Group definitions into H3-level sections organized into H2s, improving
  readability by presenting the more central components first.

- Group "Machine ID" with "Teleport Services" to simplify the glossary.

- Call instances of a Teleport Service an "agent". This is consistent
  with our source and informal language about Teleport. This also
  removes the "Node" terminology, which is prone to misuse (does it mean
  "a Service instance"? An "SSH Service instance"? Both are present in
  the docs) and easily confused with the lowercase "node" (i.e., a
  host).

- For simplicity, remove the term "Teleport Process" and simply explain
  that multiple Teleport Services can run via the same binary.

- Add a section on Teleport's editions, including the terms "Community
  Edition", "Enterprise", and "Enterprise Cloud".

- Remove the mention of Teleport Discover, which isn't documented yet.

- Minor wording/readability changes.

* Respond to PR feedback

* Respond to zmb3 feedback
2022-12-08 17:32:50 +00:00
Alexander Klizhentas 7fc8f4dfd6 Refactoring of architecture section. (#13651)
Our architecture section was written almost 5 years ago
and was completely obsolete.

I refactored all of it to be up to date, added Kuberentes
and other resource type references, replaced and created new diagrams.
2022-06-23 18:39:49 +00:00
Alexander Klizhentas f521bddb08 move production and user manuals (#8341) 2021-09-21 20:22:21 -07:00
Alexander Klizhentas cfc4567906 Splits admin guide into setup sections (#8324)
* Updates scaling guide.
* Rewrites CA rotation guide.
* Small tweaks and fixes to other parts.
2021-09-20 10:22:12 -07:00
Alexander KlizhentasandBen Arent e49e894efe Sasha/fwd user (#7996)
* Video Banner (#7914)

* Drain off admin guide into setup sections. (#7960)

* Expand daemon section and graceful restarts guide
* Move API section to top
* Move references to setup

Co-authored-by: Ben Arent <ben@goteleport.com>
2021-08-19 15:00:26 -07:00
inertial-frame 4d919e3878 docs: port to 7.0 (#7373) 2021-07-01 10:27:59 -05:00
inertial-frame 427a327333 [v7.0] docs: port of edit pass 5/9 (#7316)
* docs: port from 6.2

* docs: correct port
2021-06-15 17:18:05 -05:00
Alexey Ivanov 3bf8425876 v7.0 syntax update (#6314)
* Update syntax

# Conflicts:
#	docs/pages/enterprise/sso/ssh-google-workspace.mdx

* Run lint and fix lint errors

* Fix include path
2021-04-06 12:16:28 -07:00
Alexey Ivanov 306f74b211 Lint markdown files syntax for master with the new linter (#5881)
* Lint docs files
* Fix includes
* Remove releases-table
2021-03-08 08:39:48 -08:00
Alexey Ivanov fa4d7eb977 Update docs structure (#5849) 2021-03-04 10:07:48 -08:00