From 32ad9cbedb3ab5f7131001b1e66633d157b7312a Mon Sep 17 00:00:00 2001 From: Lisa Gunn Date: Thu, 28 Sep 2023 11:11:23 -0700 Subject: [PATCH 1/2] Fix typos, use specific titles, add pointers to the official documentation --- access/README.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/access/README.md b/access/README.md index f84c5d3ef..1ba21b91d 100644 --- a/access/README.md +++ b/access/README.md @@ -1,11 +1,26 @@ -# Access Plugins +# Access request plugins -The various plugins within this directory allow teleport users the ability to intergrate access request notifications and approval workflows with third party technologies. They also serve as examples for building your own integration. For more information on the plugins available visit the `README.md` within each plugins respective directory. +The access request plugins in this directory allow Teleport users to integrate access request notifications and approval workflows with third party messaging, project management, and scheduling solutions. These plugins also serve as examples for building your own integration. +If you have a self-hosted Teleport deployment, you can find information for configuring these access +request plugins in [Just-in-Time Access Request Plugins](https://goteleport.com/docs/access-controls/access-request-plugins/). -For more information on Access Requests with Teleport, check out this [blog post](https://goteleport.com/blog/access-requests/) +For an overview of the complete workflow for access requests and how messaging, project management, and scheduling solutions integrate with Teleport, see the [Access Requests for Cloud Infrastructure](https://goteleport.com/blog/access-requests/) blog post. -### Access API +## Access API -The Teleport Access API has been moved into the main Teleport repo, and can be imported from `github.com/gravitational/teleport/api`. To see examples of how to get started with the Teleport API, take a look at our [go-client example](https://github.com/gravitational/teleport/tree/master/examples/go-client) or read the [API docs](https://goteleport.com/docs/api/introduction/). +The Teleport Access API has been moved into the main Teleport repository. +You can import it from `github.com/gravitational/teleport/api`. To see examples of how to get started with the Teleport API, see the [go-client example](https://github.com/gravitational/teleport/tree/master/examples/go-client) or read the [API docs](https://goteleport.com/docs/api/introduction/). +For more specific examples of how to build a custom access request workflow with the Teleport API, see [How to Build an Access Request Plugin](https://goteleport.com/docs/api/access-plugin/). -For more specific examples of how to manage workflows with the Teleport API, take a look at the [Plugin example](https://goteleport.com/docs/api/access-plugin/). +## Existing plugin guides + +The Teleport documentation includes access request plugins guides for integration +with the following solutions: + +- [Discord](https://goteleport.com/docs/ver/15.x/access-controls/access-request-plugins/ssh-approval-discord/) +- [Email](https://goteleport.com/docs/ver/15.x/access-controls/access-request-plugins/ssh-approval-email/) +- [JIRA](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-jira/) +- [Mattermost](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-mattermost/) +- [Microsoft Teams](https://goteleport.com/docs/ver/15.x/access-controls/access-request-plugins/ssh-approval-msteams/) +- [PagerDuty](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-pagerduty/) +- [Slack](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-slack/) \ No newline at end of file From 95179438ed9412d62a3ab13c988652842bee1406 Mon Sep 17 00:00:00 2001 From: lsgunn-teleport <136391445+lsgunn-teleport@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:24:21 -0700 Subject: [PATCH 2/2] Update access/README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Marco André Dinis --- access/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/access/README.md b/access/README.md index 1ba21b91d..4bc1fbf57 100644 --- a/access/README.md +++ b/access/README.md @@ -17,10 +17,10 @@ For more specific examples of how to build a custom access request workflow with The Teleport documentation includes access request plugins guides for integration with the following solutions: -- [Discord](https://goteleport.com/docs/ver/15.x/access-controls/access-request-plugins/ssh-approval-discord/) -- [Email](https://goteleport.com/docs/ver/15.x/access-controls/access-request-plugins/ssh-approval-email/) +- [Discord](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-discord/) +- [Email](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-email/) - [JIRA](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-jira/) - [Mattermost](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-mattermost/) -- [Microsoft Teams](https://goteleport.com/docs/ver/15.x/access-controls/access-request-plugins/ssh-approval-msteams/) +- [Microsoft Teams](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-msteams/) - [PagerDuty](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-pagerduty/) - [Slack](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-slack/) \ No newline at end of file