Edit the Enterprise migration guide #41285
Merged
+373
−212
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
**Edit the guide for structure and style:**
- Use title case in the title.
- Wrap lines at 80 chars.
- Begin H2s with "Step n/d"
- Move the Conclusion text to the intro. How-to guides do not include
conclusions in our docs, and this information is valuable at the start
of the guide.
- Use numbered steps for instructions.
- Use relative file paths for links.
- Minor style edits.
**Remove the "Verify connectivity" step:** This repeats instructions
from the step to deploy a cloud-hosted cluster.
**Add a note on migrating plugins and Machine ID Bots:** the guide only
includes instructions for migrating agents in the section on migrating
services. This change suggests linking to docs on migrating plugins and
Bots.
**Edit the navigation:**
- Add a link to the navigation sidebar.
- Edit the "Choose a Teleport Edition" intro page to (a) imply that
cloud-hosted is the recommended solution and (b) link to the
migration guide.
ptgott
force-pushed
the
paul.gottschling/40172-edits
branch
from
9740046 to
260cec4
Compare
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
|
🤖 Vercel preview here: https://docs-poozxvuau-goteleport.vercel.app/docs/ver/preview |
webvictim
reviewed
May 17, 2024
Comment on lines
7
to
12
| Migrating from a Teleport Enterprise (self-hosted) deployment to Teleport | ||
| Enterprise (cloud-hosted) offers scalability, reliability, and ease of | ||
| management. By following the steps outlined in this guide, you can transition | ||
| your Teleport Enterprise (self-hosted) deployment to Teleport Enterprise | ||
| (cloud-hosted) successfully while ensuring minimal disruption to your | ||
| operations. |
There was a problem hiding this comment.
I'm probably yelling into the void and the decision has already been made above my pay grade, but I really don't like this whole "same product name with different qualifier in brackets" style. It's just clunky and awkward to read.
There was a problem hiding this comment.
I've opened a PR to clarify the style rule. From what I understand, it's less important that we use Teleport Enterprise (self/cloud-hosted) than use "Teleport Enterprise" for the edition name and clarify the hosting type in some other way, outside the product name.
- Reduce the overuse of `Teleport Enterprise (cloud|self-hosted)`. - Move the note re: trusted clusters to the Prerequisites. - Mention the `--auth` flag in `tsh login` commands. - Fix typo. - Add a note about the `proxy_server` field
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
ptgott
added
the
no-changelog
|
🤖 Vercel preview here: https://docs-4h7rmab37-goteleport.vercel.app/docs/ver/preview |
webvictim
approved these changes
May 29, 2024
oshati
approved these changes
May 29, 2024
ptgott
merged commit 81b660c
into
oo-Migrate-from-self-hosted-to-Teleport-enterprise-cloud
31 of 34 checks passed
ptgott
added a commit
that referenced
this pull request
Jun 13, 2024
* Edit the Enterprise migration guide
**Edit the guide for structure and style:**
- Use title case in the title.
- Wrap lines at 80 chars.
- Begin H2s with "Step n/d"
- Move the Conclusion text to the intro. How-to guides do not include
conclusions in our docs, and this information is valuable at the start
of the guide.
- Use numbered steps for instructions.
- Use relative file paths for links.
- Minor style edits.
**Remove the "Verify connectivity" step:** This repeats instructions
from the step to deploy a cloud-hosted cluster.
**Add a note on migrating plugins and Machine ID Bots:** the guide only
includes instructions for migrating agents in the section on migrating
services. This change suggests linking to docs on migrating plugins and
Bots.
**Edit the navigation:**
- Add a link to the navigation sidebar.
- Edit the "Choose a Teleport Edition" intro page to (a) imply that
cloud-hosted is the recommended solution and (b) link to the
migration guide.
* Respond to webvictim feedback
- Reduce the overuse of `Teleport Enterprise (cloud|self-hosted)`.
- Move the note re: trusted clusters to the Prerequisites.
- Mention the `--auth` flag in `tsh login` commands.
- Fix typo.
- Add a note about the `proxy_server` field
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jun 13, 2024
* Migrate from self-hosted to Teleport-enterprise cloud * Update migrating.mdx * update guide * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * Update docs/pages/migrating.mdx Co-authored-by: Jeff Anderson <[email protected]> * update cloud migration doc * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * update cloud migration doc * update cloud migration doc * Edit the Enterprise migration guide (#41285) * Edit the Enterprise migration guide **Edit the guide for structure and style:** - Use title case in the title. - Wrap lines at 80 chars. - Begin H2s with "Step n/d" - Move the Conclusion text to the intro. How-to guides do not include conclusions in our docs, and this information is valuable at the start of the guide. - Use numbered steps for instructions. - Use relative file paths for links. - Minor style edits. **Remove the "Verify connectivity" step:** This repeats instructions from the step to deploy a cloud-hosted cluster. **Add a note on migrating plugins and Machine ID Bots:** the guide only includes instructions for migrating agents in the section on migrating services. This change suggests linking to docs on migrating plugins and Bots. **Edit the navigation:** - Add a link to the navigation sidebar. - Edit the "Choose a Teleport Edition" intro page to (a) imply that cloud-hosted is the recommended solution and (b) link to the migration guide. * Respond to webvictim feedback - Reduce the overuse of `Teleport Enterprise (cloud|self-hosted)`. - Move the note re: trusted clusters to the Prerequisites. - Mention the `--auth` flag in `tsh login` commands. - Fix typo. - Add a note about the `proxy_server` field * Update docs/pages/choose-an-edition/migrate-to-cloud.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/choose-an-edition/migrate-to-cloud.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/choose-an-edition/migrate-to-cloud.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/choose-an-edition/migrate-to-cloud.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/choose-an-edition/migrate-to-cloud.mdx Co-authored-by: Gus Luxton <[email protected]> * fix docs * fix docs * Apply suggestions from code review Co-authored-by: Gus Luxton <[email protected]> * Fix linter issues --------- Co-authored-by: Jeff Anderson <[email protected]> Co-authored-by: Gus Luxton <[email protected]> Co-authored-by: Paul Gottschling <[email protected]>
github-actions bot
pushed a commit
that referenced
this pull request
Jun 13, 2024
* Edit the Enterprise migration guide
**Edit the guide for structure and style:**
- Use title case in the title.
- Wrap lines at 80 chars.
- Begin H2s with "Step n/d"
- Move the Conclusion text to the intro. How-to guides do not include
conclusions in our docs, and this information is valuable at the start
of the guide.
- Use numbered steps for instructions.
- Use relative file paths for links.
- Minor style edits.
**Remove the "Verify connectivity" step:** This repeats instructions
from the step to deploy a cloud-hosted cluster.
**Add a note on migrating plugins and Machine ID Bots:** the guide only
includes instructions for migrating agents in the section on migrating
services. This change suggests linking to docs on migrating plugins and
Bots.
**Edit the navigation:**
- Add a link to the navigation sidebar.
- Edit the "Choose a Teleport Edition" intro page to (a) imply that
cloud-hosted is the recommended solution and (b) link to the
migration guide.
* Respond to webvictim feedback
- Reduce the overuse of `Teleport Enterprise (cloud|self-hosted)`.
- Move the note re: trusted clusters to the Prerequisites.
- Mention the `--auth` flag in `tsh login` commands.
- Fix typo.
- Add a note about the `proxy_server` field
github-actions bot
pushed a commit
that referenced
this pull request
Jun 13, 2024
* Edit the Enterprise migration guide
**Edit the guide for structure and style:**
- Use title case in the title.
- Wrap lines at 80 chars.
- Begin H2s with "Step n/d"
- Move the Conclusion text to the intro. How-to guides do not include
conclusions in our docs, and this information is valuable at the start
of the guide.
- Use numbered steps for instructions.
- Use relative file paths for links.
- Minor style edits.
**Remove the "Verify connectivity" step:** This repeats instructions
from the step to deploy a cloud-hosted cluster.
**Add a note on migrating plugins and Machine ID Bots:** the guide only
includes instructions for migrating agents in the section on migrating
services. This change suggests linking to docs on migrating plugins and
Bots.
**Edit the navigation:**
- Add a link to the navigation sidebar.
- Edit the "Choose a Teleport Edition" intro page to (a) imply that
cloud-hosted is the recommended solution and (b) link to the
migration guide.
* Respond to webvictim feedback
- Reduce the overuse of `Teleport Enterprise (cloud|self-hosted)`.
- Move the note re: trusted clusters to the Prerequisites.
- Mention the `--auth` flag in `tsh login` commands.
- Fix typo.
- Add a note about the `proxy_server` field
ptgott
added a commit
that referenced
this pull request
Jun 20, 2024
* Edit the Enterprise migration guide
**Edit the guide for structure and style:**
- Use title case in the title.
- Wrap lines at 80 chars.
- Begin H2s with "Step n/d"
- Move the Conclusion text to the intro. How-to guides do not include
conclusions in our docs, and this information is valuable at the start
of the guide.
- Use numbered steps for instructions.
- Use relative file paths for links.
- Minor style edits.
**Remove the "Verify connectivity" step:** This repeats instructions
from the step to deploy a cloud-hosted cluster.
**Add a note on migrating plugins and Machine ID Bots:** the guide only
includes instructions for migrating agents in the section on migrating
services. This change suggests linking to docs on migrating plugins and
Bots.
**Edit the navigation:**
- Add a link to the navigation sidebar.
- Edit the "Choose a Teleport Edition" intro page to (a) imply that
cloud-hosted is the recommended solution and (b) link to the
migration guide.
* Respond to webvictim feedback
- Reduce the overuse of `Teleport Enterprise (cloud|self-hosted)`.
- Move the note re: trusted clusters to the Prerequisites.
- Mention the `--auth` flag in `tsh login` commands.
- Fix typo.
- Add a note about the `proxy_server` field
ptgott
added a commit
that referenced
this pull request
Jun 20, 2024
* Edit the Enterprise migration guide
**Edit the guide for structure and style:**
- Use title case in the title.
- Wrap lines at 80 chars.
- Begin H2s with "Step n/d"
- Move the Conclusion text to the intro. How-to guides do not include
conclusions in our docs, and this information is valuable at the start
of the guide.
- Use numbered steps for instructions.
- Use relative file paths for links.
- Minor style edits.
**Remove the "Verify connectivity" step:** This repeats instructions
from the step to deploy a cloud-hosted cluster.
**Add a note on migrating plugins and Machine ID Bots:** the guide only
includes instructions for migrating agents in the section on migrating
services. This change suggests linking to docs on migrating plugins and
Bots.
**Edit the navigation:**
- Add a link to the navigation sidebar.
- Edit the "Choose a Teleport Edition" intro page to (a) imply that
cloud-hosted is the recommended solution and (b) link to the
migration guide.
* Respond to webvictim feedback
- Reduce the overuse of `Teleport Enterprise (cloud|self-hosted)`.
- Move the note re: trusted clusters to the Prerequisites.
- Mention the `--auth` flag in `tsh login` commands.
- Fix typo.
- Add a note about the `proxy_server` field
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jun 20, 2024
* Migrate from self-hosted to Teleport-enterprise cloud * Update migrating.mdx * update guide * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * Update docs/pages/migrating.mdx Co-authored-by: Jeff Anderson <[email protected]> * update cloud migration doc * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * update cloud migration doc * update cloud migration doc * Edit the Enterprise migration guide (#41285) * Edit the Enterprise migration guide **Edit the guide for structure and style:** - Use title case in the title. - Wrap lines at 80 chars. - Begin H2s with "Step n/d" - Move the Conclusion text to the intro. How-to guides do not include conclusions in our docs, and this information is valuable at the start of the guide. - Use numbered steps for instructions. - Use relative file paths for links. - Minor style edits. **Remove the "Verify connectivity" step:** This repeats instructions from the step to deploy a cloud-hosted cluster. **Add a note on migrating plugins and Machine ID Bots:** the guide only includes instructions for migrating agents in the section on migrating services. This change suggests linking to docs on migrating plugins and Bots. **Edit the navigation:** - Add a link to the navigation sidebar. - Edit the "Choose a Teleport Edition" intro page to (a) imply that cloud-hosted is the recommended solution and (b) link to the migration guide. * Respond to webvictim feedback - Reduce the overuse of `Teleport Enterprise (cloud|self-hosted)`. - Move the note re: trusted clusters to the Prerequisites. - Mention the `--auth` flag in `tsh login` commands. - Fix typo. - Add a note about the `proxy_server` field * Update docs/pages/choose-an-edition/migrate-to-cloud.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/choose-an-edition/migrate-to-cloud.mdx Co-authored-by: Gus Luxton <[email protected]> * Fix linter issues --------- Co-authored-by: Jeff Anderson <[email protected]> Co-authored-by: Gus Luxton <[email protected]> Co-authored-by: Paul Gottschling <[email protected]>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jun 20, 2024
* Migrate from self-hosted to Teleport-enterprise cloud * Update migrating.mdx * update guide * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * Update docs/pages/migrating.mdx Co-authored-by: Jeff Anderson <[email protected]> * update cloud migration doc * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * update cloud migration doc * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/migrating.mdx Co-authored-by: Gus Luxton <[email protected]> * update cloud migration doc * update cloud migration doc * Edit the Enterprise migration guide (#41285) * Edit the Enterprise migration guide **Edit the guide for structure and style:** - Use title case in the title. - Wrap lines at 80 chars. - Begin H2s with "Step n/d" - Move the Conclusion text to the intro. How-to guides do not include conclusions in our docs, and this information is valuable at the start of the guide. - Use numbered steps for instructions. - Use relative file paths for links. - Minor style edits. **Remove the "Verify connectivity" step:** This repeats instructions from the step to deploy a cloud-hosted cluster. **Add a note on migrating plugins and Machine ID Bots:** the guide only includes instructions for migrating agents in the section on migrating services. This change suggests linking to docs on migrating plugins and Bots. **Edit the navigation:** - Add a link to the navigation sidebar. - Edit the "Choose a Teleport Edition" intro page to (a) imply that cloud-hosted is the recommended solution and (b) link to the migration guide. * Respond to webvictim feedback - Reduce the overuse of `Teleport Enterprise (cloud|self-hosted)`. - Move the note re: trusted clusters to the Prerequisites. - Mention the `--auth` flag in `tsh login` commands. - Fix typo. - Add a note about the `proxy_server` field * Update docs/pages/choose-an-edition/migrate-to-cloud.mdx Co-authored-by: Gus Luxton <[email protected]> * Update docs/pages/choose-an-edition/migrate-to-cloud.mdx Co-authored-by: Gus Luxton <[email protected]> * Fix linter issues --------- Co-authored-by: Jeff Anderson <[email protected]> Co-authored-by: Gus Luxton <[email protected]> Co-authored-by: Paul Gottschling <[email protected]>
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.
Edit the guide for structure and style:
Remove the "Verify connectivity" step: This repeats instructions from the step to deploy a cloud-hosted cluster.
Add a note on migrating plugins and Machine ID Bots: the guide only includes instructions for migrating agents in the section on migrating services. This change suggests linking to docs on migrating plugins and Bots.
Edit the navigation: