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

[docs] update RDS guides #41682

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

GavinFrazar
Copy link
Contributor

This is a docs only PR that updates our RDS guides.

For the RDS Aurora/instance guide:

  1. condenses the RDS guide's teleport db configure commands from 2 to 1
  2. eliminates the unused region variable and the unnecessary helm chart region variable (teleport will derive it from the uri)
  3. changes the example database name to "rds-example" instead of a configurable variable. The database name isn't relevant to the guide and we shouldn't use a variable for because it messes up the example tsh db ls output table format.

For RDS Proxy:

  1. split up the first step, which was doing a lot, into separate steps: install teleport > configure teleport > configure aws credentials.
  2. removed outdated explanation about teleport db configure create - the example command doesn't output the deprecated db discovery config

@GavinFrazar GavinFrazar added documentation aws Used for AWS Related Issues. database-access Database access related issues and PRs backport/branch/v14 no-changelog Indicates that a PR does not require a changelog entry backport/branch/v15 labels May 17, 2024
Copy link

🤖 Vercel preview here: https://docs-a0znlrd8r-goteleport.vercel.app/docs/ver/preview

Copy link

🤖 Vercel preview here: https://docs-33j9w239c-goteleport.vercel.app/docs/ver/preview

Copy link
Contributor

@greedy52 greedy52 left a comment

Choose a reason for hiding this comment

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

Unrelated. We should fix this ordering:
Screenshot 2024-05-17 at 9 23 53 AM

We used to order by alphabet but now it's quite random. And some starts with AWS and some does not.

I think we should order by usage and what we want to promote.

docs/pages/database-access/enroll-aws-databases/rds.mdx Outdated Show resolved Hide resolved
docs/pages/database-access/enroll-aws-databases/rds.mdx Outdated Show resolved Hide resolved
</TabItem>
<TabItem scope={["cloud"]} label="Teleport Enterprise Cloud">
![Teleport Database Access RDS Proxy Cloud](../../../img/database-access/guides/rds-proxy_cloud.png)
<TabItem label="Teleport Enterprise (cloud-hosted)">
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<TabItem label="Teleport Enterprise (cloud-hosted)">
<TabItem label="Cloud-Hosted">

@GavinFrazar
Copy link
Contributor Author

GavinFrazar commented May 21, 2024

Unrelated. We should fix this ordering: Screenshot 2024-05-17 at 9 23 53 AM

We used to order by alphabet but now it's quite random. And some starts with AWS and some does not.

I think we should order by usage and what we want to promote.

@ptgott @greedy52
Is adding a star emoji too much? e.g.:
image

* remove use of the AWS acronym
* sort the links
* highlight RDS with a star emoji
Copy link

🤖 Vercel preview here: https://docs-5wayqijcc-goteleport.vercel.app/docs/ver/preview

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aws Used for AWS Related Issues. backport/branch/v14 backport/branch/v15 backport/branch/v16 database-access Database access related issues and PRs documentation no-changelog Indicates that a PR does not require a changelog entry size/sm
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants