Skip to content

Updating the Postgres RDS docs [DOC-504] #2822

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

Merged
merged 13 commits into from
May 5, 2022
Merged

Conversation

forstisabella
Copy link
Contributor

@forstisabella forstisabella commented Apr 29, 2022

Proposed changes

I’ve updated the Network Permissions section so that it references correct UI terms, and removed the step-by-step instructions for creating an PostgreSQL database to instead link to AWS’s DB creation docs (so we’re not on the hook for updating the instructions again when AWS makes more UI changes.)

Merge timing

With the next regular docs release, pending approval from the PM for this product!

Related issues (optional)

#2735

@forstisabella forstisabella added the content-update updates to content that are not new features, includes grammar fixes, added notes label Apr 29, 2022
@forstisabella forstisabella marked this pull request as draft April 29, 2022 15:50
@forstisabella forstisabella marked this pull request as ready for review April 29, 2022 15:50
@forstisabella forstisabella linked an issue Apr 29, 2022 that may be closed by this pull request
Copy link
Contributor

@markzegarelli markzegarelli left a comment

Choose a reason for hiding this comment

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

Looks good!

A few general comments:

  1. Please add {:target="_blank"} to all external URLs.
  2. I'm not sure the troubleshooting section at the bottom needs to be a table. Changing these to headings / paragraphs will help searchability and maintainability. I also noticed one instance of we in one of the cells.


As a supplement to this guide, Amazon has created an official guide to [setting up a Postgres database](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.PostgreSQL.html).
Create a new PostgreSQL database in RDS by following the steps in Amazon's documentation, [Creating a PostgreSQL DB instance and connecting to a database on a PostgreSQL DB instance](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.PostgreSQL.html). For best performance, create your database in the `US West` region.
Copy link
Contributor

Choose a reason for hiding this comment

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

You can reorder the first sentence to make it active-voice.

"Follow the steps in Amazon's documentation to create a new PostgreSQL..."

@forstisabella forstisabella merged commit 96ad08f into develop May 5, 2022
@forstisabella forstisabella deleted the postgres-rds-update branch May 5, 2022 15:57
@github-actions
Copy link
Contributor

github-actions bot commented May 5, 2022

Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content-update updates to content that are not new features, includes grammar fixes, added notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Content]: RDS Documentation out of date
2 participants