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.

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

Edit four docs guides for Cloud users #10738

Merged
merged 1 commit into from
Apr 14, 2022

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Mar 2, 2022

See #10633

Labels

  • Turn the Prerequisites into a Tabs box for different editions.
    This means that users of one edition will not need to see
    information intended for users of another edition.

  • Add misc. clarity, grammar, and style edits.

Local Users

  • Use Tabs for the Prerequisites so users of one edition don't see
    information for another edition
  • SSO was briefly mentioned without elaboration, so I added this to a
    Further Reading section with scoped tabs
  • Use Tabs for Proxy connection instructions

Troubleshooting

  • Add a note re: the relevance of the guide for Cloud users
  • Add Tabs for the Getting help section so commercial or OSS users
    don't see irrelevant information
  • General clarity, grammar, and style tweaks

Graceful Restarts

  • Add a notice indicating how this guide is relevant for Cloud users
  • Misc clarity, grammar, and style tweaks

@github-actions github-actions bot requested review from r0mant, xinding33 and zmb3 March 2, 2022 16:33
@ptgott ptgott force-pushed the paul.gottschling/10633-setup-cloud-3 branch 3 times, most recently from 87e8cd6 to 47f6d4a Compare March 10, 2022 20:55
@russjones russjones added the cloud Cloud label Mar 11, 2022
@ptgott ptgott force-pushed the paul.gottschling/10633-setup-cloud-3 branch from 47f6d4a to 5156b35 Compare March 14, 2022 21:22
directory. Assuming the default location, `rm -rf /var/lib/teleport/*` will do.
Sometimes you may want to reset the `teleport` process to a clean state. This
can be accomplished by erasing everything under the `"data_dir"` directory.
Assuming the default location, `rm -rf /var/lib/teleport/*` will do.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe make this rm -rfi /var/lib/teleport/* just in case someone is typing this manually and absentmindedly types rm -rf /var/lib by mistake.

Copy link
Contributor

@ulysseskan ulysseskan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reviewed each of the files changed and they all look good to me. I made one minor safety suggestion above but it's up to you if you want to make that change.

@ptgott ptgott force-pushed the paul.gottschling/10633-setup-cloud-3 branch 3 times, most recently from 002ef9a to 5dd867e Compare March 18, 2022 21:07
@russjones russjones added cloud-docs and removed cloud Cloud labels Mar 18, 2022
@ptgott ptgott force-pushed the paul.gottschling/10633-setup-cloud-3 branch 2 times, most recently from 34c4ae5 to 7ae6453 Compare March 28, 2022 19:46
@ptgott ptgott force-pushed the paul.gottschling/10633-setup-cloud-3 branch 2 times, most recently from 01c9a74 to b0b596b Compare April 5, 2022 19:25
@ptgott ptgott force-pushed the paul.gottschling/10633-setup-cloud-3 branch 3 times, most recently from 8d2eb8b to d40a8d9 Compare April 12, 2022 18:41

## Prerequisites

(!docs/pages/includes/edition-prereqs-tabs.mdx!)

(!docs/pages/includes/tctl.mdx!)

## Labeling Nodes and Applications
## Labeling nodes and applications
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I thought we were capitalizing Node
  2. Why mention nodes and apps here, given the title is just "how to label Teleport Nodes" and there are many other resources that also can be labeled (kube clusters, dbs, desktops, etc) What's special about applications that they get to be included here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is how it was before I started editing the guide, and a full update was out of scope for that particular sprint. I've replaced "Nodes and applications" with variations on "Teleport resources".

@ptgott ptgott enabled auto-merge (squash) April 13, 2022 19:42
See #10633

Labels

- Turn the Prerequisites into a Tabs box for different editions.
  This means that users of one edition will not need to see
  information intended for users of another edition.

- Add misc. clarity, grammar, and style edits.

Local Users

- Use Tabs for the Prerequisites so users of one edition don't see
  information for another edition
- SSO was briefly mentioned without elaboration, so I added this to a
  Further Reading section with scoped tabs
- Use Tabs for Proxy connection instructions

Troubleshooting

- Add a note re: the relevance of the guide for Cloud users
- Add Tabs for the Getting help section so commercial or OSS users
  don't see irrelevant information
- General clarity, grammar, and style tweaks

Graceful Restarts

- Add a notice indicating how this guide is relevant for Cloud users
- Misc clarity, grammar, and style tweaks
@ptgott ptgott force-pushed the paul.gottschling/10633-setup-cloud-3 branch from d40a8d9 to dc4d3ef Compare April 14, 2022 20:13
@ptgott ptgott merged commit d3bade5 into master Apr 14, 2022
@ptgott ptgott deleted the paul.gottschling/10633-setup-cloud-3 branch April 14, 2022 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants