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

Clarify multiple fields in IP restrictions #5727

Closed
1 task done
mirnawong1 opened this issue Jul 3, 2024 · 1 comment · Fixed by #6020
Closed
1 task done

Clarify multiple fields in IP restrictions #5727

mirnawong1 opened this issue Jul 3, 2024 · 1 comment · Fixed by #6020
Assignees
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear priority: high Technical inaccuracy, missing/incorrect information, or broken links. Negatively affects workflows priority: medium Fix or enhancement to existing information that’s creating some requests from customers size: medium This change will take up to a week to address

Comments

@mirnawong1
Copy link
Contributor

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

Motivated by this internal slack thread, there are a couple of things to update in this doc:

  • It's not entirely explicit that the users can add multiple IP ranges by clicking the 'Add IP range' button to create a new text field. We should make it a bit more explicit in the docs.
  • Another small issue is this sentence doesn't link to Enabling restrictions, which it should.
  • The 'Enabling restrictions' header should also be sentence case e.g. Enabling restrictions and not Enabling Restrictions

What part(s) of the page would you like to see updated?

This is the page: https://docs.getdbt.com/docs/cloud/secure/ip-restrictions#allowing-ips and this is the specific text that might benefit from clarification or a screenshot:

### Allowing IPs

To add an IP to the allowlist, from the **IP Restrictions** page:

1.  Click **edit**
2. Click **Add Rule**
3. Add name and description for the rule
    - For example, Corporate VPN CIDR Range
4. Select **Allow**
5. Add the ranges in the CIDR notation
	- For example, 1.1.1.1/8
	- You can add multiple ranges in the same rule.
6. Click **Save**

Additional information

No response

@mirnawong1 mirnawong1 added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear size: medium This change will take up to a week to address priority: high Technical inaccuracy, missing/incorrect information, or broken links. Negatively affects workflows labels Jul 3, 2024
@mirnawong1
Copy link
Contributor Author

mirnawong1 commented Jul 3, 2024

I've set the priority to medium/high as it relates to set up instructions that affect users today and in the future.

@mirnawong1 mirnawong1 added the priority: medium Fix or enhancement to existing information that’s creating some requests from customers label Jul 5, 2024
@mirnawong1 mirnawong1 self-assigned this Jul 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear priority: high Technical inaccuracy, missing/incorrect information, or broken links. Negatively affects workflows priority: medium Fix or enhancement to existing information that’s creating some requests from customers size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant