[Tracking] Update READMEs for access request plugins to point to the main Teleport repo and official docs

[programmerq]

Applies To

The various README.md files in https://github.com/gravitational/teleport-plugins can be problematic. Sometimes they have more information than their counterpart in this repo. Other times they will be outdated or have other issues.

Given that the access plugins themselves will be moving out of the teleport-plugins repo, any info in their corresponding README.md should be ported over to the corresponding docs page in this repo.

The plugin helm charts that are in the teleport-plugins repo can also have issues. Whether those charts will be ported to this repo or not, I think they should have an extremely minimal README.md that points to their corresponding chart reference doc on goteleport.com/docs and any other relevant docs.

Details

Considering the pagerduty plugin, these are the locations where info can be found:

• chart reference doc
• plugin guide doc
• chart readme
  • has an incorrect role (it was correct as of Teleport 6.2.x)
  • has a misleading typo in its toml example.
  • chart reference table that is not as good as the one in the official docs.
• plugin readme
  • has additional information not in the guide, like how to set up a pagerduty notification alert
  • has an incorrect role (it was correct as of Teleport 6.2.x)
  • outdated information about version compatibility
  • outdated download URLs/versions

The other plugins may have similar discrepancies between the various places.

How will we know this is resolved?

All the docs for the plugins in this repo.

Related Issues

gravitational/teleport-plugins#852
gravitational/teleport-plugins#839

Tasks

Preview Give feedback

1. Top-level README.md
2. docs: Revise top-level ReadMe to point to official documentation teleport-plugins#932
   +0
   
3. Access directory README.md
4. docs: Revise access README teleport-plugins#933
   +0
   
5. Discord - Add Docker image to installation & run in official documentation
6. docs: Remove old Discord plugin content, point to the new location and official documentation teleport-plugins#934
   +0
   
7. docs: Add Docker to partials and update the discord access request plugin #32886
   backport/branch/v12 backport/branch/v13 backport/branch/v14 documentation size/sm +5
8. Email - Add Docker image to installation & run in official documentation
9. docs: Remove old Email content, point to official documentation teleport-plugins#938
   +0
   
10. docs: Add Docker to email access request plugin #33239
    backport/branch/v12 backport/branch/v13 backport/branch/v14 documentation size/sm +5
11. JIRA - Add Docker image to installation & run in official documentation, Jira Cloud, Jira Server
12. docs: Remove old Jira plugin content, point to the new location and official documentation teleport-plugins#939
    +0
    
13. Refresh the Jira Access Request plugin guide #29827
    backport/branch/v13 backport/branch/v14 documentation no-changelog size/lg +5
14. docs: Add Docker to Jira access request plugin #33327
    backport/branch/v12 backport/branch/v13 backport/branch/v14 documentation size/sm +5
15. Mattermost - Add Docker image installation & run in official documentation, sandbox, workflow
16. docs: Remove old Mattermost plugin content, point to the new location and o… teleport-plugins#940
    +0
    
17. docs: Add Docker to Mattermost access request plugin #33328
    backport/branch/v12 backport/branch/v13 backport/branch/v14 documentation size/sm +5
18. Microsoft Teams - Add Docker image installation & run in official documentation, bot and app configuration
19. docs: Remove old MSFT Teams content and point to official documentation teleport-plugins#941
    +0
    
20. docs: Add Docker to MSFT teams plugin #33326
    backport/branch/v12 backport/branch/v13 backport/branch/v14 documentation size/sm +5
21. PagerDuty - Add Docker image installation & run in official documentation, API, notification, auto-approval
22. docs: Remove old PagerDuty content, point to new location and official documentation teleport-plugins#942
    +0
    
23. docs: Add Docker and notification to the PagerDuty access request plugin #33334
    backport/branch/v12 backport/branch/v13 backport/branch/v14 documentation size/sm +5
24. Slack Add Docker image installation & run in official documentation
25. docs: Remove old Slack content, point to new location and official documentation teleport-plugins#943
    +0
    
26. Add Docker to Slack access request plugin #33330
    backport/branch/v12 backport/branch/v13 backport/branch/v14 documentation size/sm +5

[ptgott]

Closing as complete