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

Refactor Database Access Controls docs #41917

Closed
ptgott opened this issue May 22, 2024 · 0 comments · Fixed by #41925
Closed

Refactor Database Access Controls docs #41917

ptgott opened this issue May 22, 2024 · 0 comments · Fixed by #41925
Assignees

Comments

@ptgott
Copy link
Contributor

ptgott commented May 22, 2024

Applies To

Details

The Database Access Controls guide contains a mixture of instructions for database object import rules and other database-related RBAC instructions, but falls under the Auto User Provisioning section. Meanwhile, the Database Access section of the docs includes a page called Database Access RBAC. Let's either better separate these pages or factor them together.

How will we know this is resolved?

There is no longer a confusing division of topics between the Database Access RBAC and Database Access Controls guides.

@ptgott ptgott self-assigned this May 22, 2024
ptgott added a commit that referenced this issue May 22, 2024
Closes #41917

Merge the Database Object Permissions guide into the Database Access
RBAC guide for greater discoverability and a clearer division of labor
between the two guides.

This change also includes the following edits to make the refactor
cleaner, since we can include each troubleshooting step as a separate H3
in the dateabase object permissions H2:

- Remove an unnecessary troubleshooting step: One step indicates that
  import rules are validated, which is unnecessary to document, since
  validation errors are self explanatory.
- Instead of mentioning the admin user as a troubleshooting step, add a
  separate H3 for the admin user and describe the `admin_user` field,
  which was not mentioned in the original database object permissions
  guide.
ptgott added a commit that referenced this issue May 31, 2024
Closes #41917

Merge the Database Object Permissions guide into the Database Access
RBAC guide for greater discoverability and a clearer division of labor
between the two guides.

This change also includes the following edits to make the refactor
cleaner, since we can include each troubleshooting step as a separate H3
in the dateabase object permissions H2:

- Remove an unnecessary troubleshooting step: One step indicates that
  import rules are validated, which is unnecessary to document, since
  validation errors are self explanatory.
- Instead of mentioning the admin user as a troubleshooting step, add a
  separate H3 for the admin user and describe the `admin_user` field,
  which was not mentioned in the original database object permissions
  guide.
ptgott added a commit that referenced this issue May 31, 2024
Closes #41917

Merge the Database Object Permissions guide into the Database Access
RBAC guide for greater discoverability and a clearer division of labor
between the two guides.

This change also includes the following edits to make the refactor
cleaner, since we can include each troubleshooting step as a separate H3
in the dateabase object permissions H2:

- Remove an unnecessary troubleshooting step: One step indicates that
  import rules are validated, which is unnecessary to document, since
  validation errors are self explanatory.
- Instead of mentioning the admin user as a troubleshooting step, add a
  separate H3 for the admin user and describe the `admin_user` field,
  which was not mentioned in the original database object permissions
  guide.
ptgott added a commit that referenced this issue May 31, 2024
Closes #41917

Merge the Database Object Permissions guide into the Database Access
RBAC guide for greater discoverability and a clearer division of labor
between the two guides.

This change also includes the following edits to make the refactor
cleaner, since we can include each troubleshooting step as a separate H3
in the dateabase object permissions H2:

- Remove an unnecessary troubleshooting step: One step indicates that
  import rules are validated, which is unnecessary to document, since
  validation errors are self explanatory.
- Instead of mentioning the admin user as a troubleshooting step, add a
  separate H3 for the admin user and describe the `admin_user` field,
  which was not mentioned in the original database object permissions
  guide.
github-merge-queue bot pushed a commit that referenced this issue Jun 3, 2024
* Refactor the Database Object Permissions guide

Closes #41917

Merge the Database Object Permissions guide into the Database Access
RBAC guide for greater discoverability and a clearer division of labor
between the two guides.

This change also includes the following edits to make the refactor
cleaner, since we can include each troubleshooting step as a separate H3
in the dateabase object permissions H2:

- Remove an unnecessary troubleshooting step: One step indicates that
  import rules are validated, which is unnecessary to document, since
  validation errors are self explanatory.
- Instead of mentioning the admin user as a troubleshooting step, add a
  separate H3 for the admin user and describe the `admin_user` field,
  which was not mentioned in the original database object permissions
  guide.

* Respond to Tener feedback

- Clarify the placing of the `admin_user` field

* Restore intro section

Per Tener and r0mant feedback, integrate the introduction from the
Database Access Controls page into the newly merged RBAC guide. Frame
Database Access Controls as encompassing both databases and database
objects.

* Respond to r0mant feedback

* Fix spelling

* Fix linter issues
github-actions bot pushed a commit that referenced this issue Jun 3, 2024
Closes #41917

Merge the Database Object Permissions guide into the Database Access
RBAC guide for greater discoverability and a clearer division of labor
between the two guides.

This change also includes the following edits to make the refactor
cleaner, since we can include each troubleshooting step as a separate H3
in the dateabase object permissions H2:

- Remove an unnecessary troubleshooting step: One step indicates that
  import rules are validated, which is unnecessary to document, since
  validation errors are self explanatory.
- Instead of mentioning the admin user as a troubleshooting step, add a
  separate H3 for the admin user and describe the `admin_user` field,
  which was not mentioned in the original database object permissions
  guide.
github-actions bot pushed a commit that referenced this issue Jun 3, 2024
Closes #41917

Merge the Database Object Permissions guide into the Database Access
RBAC guide for greater discoverability and a clearer division of labor
between the two guides.

This change also includes the following edits to make the refactor
cleaner, since we can include each troubleshooting step as a separate H3
in the dateabase object permissions H2:

- Remove an unnecessary troubleshooting step: One step indicates that
  import rules are validated, which is unnecessary to document, since
  validation errors are self explanatory.
- Instead of mentioning the admin user as a troubleshooting step, add a
  separate H3 for the admin user and describe the `admin_user` field,
  which was not mentioned in the original database object permissions
  guide.
github-merge-queue bot pushed a commit that referenced this issue Jun 4, 2024
* Refactor the Database Object Permissions guide

Closes #41917

Merge the Database Object Permissions guide into the Database Access
RBAC guide for greater discoverability and a clearer division of labor
between the two guides.

This change also includes the following edits to make the refactor
cleaner, since we can include each troubleshooting step as a separate H3
in the dateabase object permissions H2:

- Remove an unnecessary troubleshooting step: One step indicates that
  import rules are validated, which is unnecessary to document, since
  validation errors are self explanatory.
- Instead of mentioning the admin user as a troubleshooting step, add a
  separate H3 for the admin user and describe the `admin_user` field,
  which was not mentioned in the original database object permissions
  guide.

* Respond to Tener feedback

- Clarify the placing of the `admin_user` field

* Restore intro section

Per Tener and r0mant feedback, integrate the introduction from the
Database Access Controls page into the newly merged RBAC guide. Frame
Database Access Controls as encompassing both databases and database
objects.

* Respond to r0mant feedback

* Fix spelling

* Fix linter issues
github-merge-queue bot pushed a commit that referenced this issue Jun 4, 2024
* Refactor the Database Object Permissions guide

Closes #41917

Merge the Database Object Permissions guide into the Database Access
RBAC guide for greater discoverability and a clearer division of labor
between the two guides.

This change also includes the following edits to make the refactor
cleaner, since we can include each troubleshooting step as a separate H3
in the dateabase object permissions H2:

- Remove an unnecessary troubleshooting step: One step indicates that
  import rules are validated, which is unnecessary to document, since
  validation errors are self explanatory.
- Instead of mentioning the admin user as a troubleshooting step, add a
  separate H3 for the admin user and describe the `admin_user` field,
  which was not mentioned in the original database object permissions
  guide.

* Respond to Tener feedback

- Clarify the placing of the `admin_user` field

* Restore intro section

Per Tener and r0mant feedback, integrate the introduction from the
Database Access Controls page into the newly merged RBAC guide. Frame
Database Access Controls as encompassing both databases and database
objects.

* Respond to r0mant feedback

* Fix spelling

* Fix linter issues
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant