Refresh the Slack access request guide #14581
Labels
Milestone
Comments
ptgott
added a commit
that referenced
this issue
Jul 25, 2022
Fixes #14581 - Flesh out the intro a bit - Fix the directory name used in the `mv` command in the installation step. Also fix the name of the binary generated by the `make` command. - Add a step to test the installation - Edit the rbac.mdx and impersonations.mdx partials to provide more context and restructure the instructions so users can follow them step by step. - Add context around other existing steps - Add more comprehensive role mapping instructions. The guide included an example role mapping, but did not spell out the general logic of the role mapping bheavior, e.g., that the "*" key is required. - Move the step re: inviting the bot to after the user configures role mapping so they know which channels to invite the bot to. - Add a section on creating roles to enable Access Requests so it is eassier to follow this guide linearly. Otherwise, users will need to do more work to match the configuration instructions with the specifics of their RBAC setup. - Capitalize "Access Request" in this and other guides, since we're adding more emphasis on this as a product. - Turn the "Audit Log" section into an Admonition and make the instructions there more accurate. - Add context to the "identity-export.mdx" partial. This is a pretty confusing part of the Access Request setup process, so I added context to explain why different identity file formats are used.
ptgott
added a commit
that referenced
this issue
Aug 1, 2022
Fixes #14581 - Flesh out the intro a bit - Fix the directory name used in the `mv` command in the installation step. Also fix the name of the binary generated by the `make` command. - Add a step to test the installation - Edit the rbac.mdx and impersonations.mdx partials to provide more context and restructure the instructions so users can follow them step by step. - Add context around other existing steps - Add more comprehensive role mapping instructions. The guide included an example role mapping, but did not spell out the general logic of the role mapping bheavior, e.g., that the "*" key is required. - Move the step re: inviting the bot to after the user configures role mapping so they know which channels to invite the bot to. - Add a section on creating roles to enable Access Requests so it is eassier to follow this guide linearly. Otherwise, users will need to do more work to match the configuration instructions with the specifics of their RBAC setup. - Capitalize "Access Request" in this and other guides, since we're adding more emphasis on this as a product. - Turn the "Audit Log" section into an Admonition and make the instructions there more accurate. - Add context to the "identity-export.mdx" partial. This is a pretty confusing part of the Access Request setup process, so I added context to explain why different identity file formats are used.
ptgott
added a commit
that referenced
this issue
Aug 1, 2022
* Edit the Slack access request plugin guide Fixes #14581 - Flesh out the intro a bit - Fix the directory name used in the `mv` command in the installation step. Also fix the name of the binary generated by the `make` command. - Add a step to test the installation - Edit the rbac.mdx and impersonations.mdx partials to provide more context and restructure the instructions so users can follow them step by step. - Add context around other existing steps - Add more comprehensive role mapping instructions. The guide included an example role mapping, but did not spell out the general logic of the role mapping bheavior, e.g., that the "*" key is required. - Move the step re: inviting the bot to after the user configures role mapping so they know which channels to invite the bot to. - Add a section on creating roles to enable Access Requests so it is eassier to follow this guide linearly. Otherwise, users will need to do more work to match the configuration instructions with the specifics of their RBAC setup. - Capitalize "Access Request" in this and other guides, since we're adding more emphasis on this as a product. - Turn the "Audit Log" section into an Admonition and make the instructions there more accurate. - Add context to the "identity-export.mdx" partial. This is a pretty confusing part of the Access Request setup process, so I added context to explain why different identity file formats are used. * Apply suggestions from code review Co-authored-by: Nic Klaassen <[email protected]> * Respond to PR review Co-authored-by: Nic Klaassen <[email protected]>
ptgott
added a commit
that referenced
this issue
Aug 1, 2022
Fixes #14581 - Flesh out the intro a bit - Fix the directory name used in the `mv` command in the installation step. Also fix the name of the binary generated by the `make` command. - Add a step to test the installation - Edit the rbac.mdx and impersonations.mdx partials to provide more context and restructure the instructions so users can follow them step by step. - Add context around other existing steps - Add more comprehensive role mapping instructions. The guide included an example role mapping, but did not spell out the general logic of the role mapping bheavior, e.g., that the "*" key is required. - Move the step re: inviting the bot to after the user configures role mapping so they know which channels to invite the bot to. - Add a section on creating roles to enable Access Requests so it is eassier to follow this guide linearly. Otherwise, users will need to do more work to match the configuration instructions with the specifics of their RBAC setup. - Capitalize "Access Request" in this and other guides, since we're adding more emphasis on this as a product. - Turn the "Audit Log" section into an Admonition and make the instructions there more accurate. - Add context to the "identity-export.mdx" partial. This is a pretty confusing part of the Access Request setup process, so I added context to explain why different identity file formats are used.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Details
See #14236
Category
The text was updated successfully, but these errors were encountered: