Skip to content

Commit

Permalink
Make Event Handler addresses consistent
Browse files Browse the repository at this point in the history 
Closes #43181

Address inconsistent information between the Event Handler README and
step-by-step guides by using the information in the step-by-step guides,
which is more in line with our current recommendations.
  • Loading branch information
@ptgott
ptgott committed Nov 5, 2024
1 parent ecd5500 commit 8d20969
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/pages/includes/plugins/config-toml-teleport.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<TabItem label="Executable or Docker">

**`addr`**: Include the hostname and HTTPS port of your Teleport Proxy Service
or Teleport Enterprise Cloud tenant (e.g., `teleport.example.com:443` or
or Teleport Enterprise Cloud account (e.g., `teleport.example.com:443` or

Check failure on line 5 in docs/pages/includes/plugins/config-toml-teleport.mdx

View workflow job for this annotation

GitHub Actions / Lint docs prose style 

[vale] reported by reviewdog 🐶
[messaging.edition-names] "Teleport Enterprise Cloud" is no longer a recognized Teleport edition. Use "Teleport Enterprise (Self-Hosted)" or "Teleport Enterprise (Cloud)" instead. If the hosting type is not important in a given sentence, there is no need to specify it, and you can use "Teleport Enterprise".

Raw Output:
{"message": "[messaging.edition-names] \"Teleport Enterprise Cloud\" is no longer a recognized Teleport edition. Use \"Teleport Enterprise (Self-Hosted)\" or \"Teleport Enterprise (Cloud)\" instead. If the hosting type is not important in a given sentence, there is no need to specify it, and you can use \"Teleport Enterprise\".", "location": {"path": "docs/pages/includes/plugins/config-toml-teleport.mdx", "range": {"start": {"line": 5, "column": 4}}}, "severity": "ERROR"}
`mytenant.teleport.sh:443`).

**`identity`**: Fill this in with the path to the identity file you exported
Expand Down
4 changes: 3 additions & 1 deletion examples/chart/event-handler/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ The following values can be set for the Helm chart:

<tr>
<td><code>teleport.address</code></td>
<td>Host/port combination of the teleport auth server</td>
<td>hostname and HTTPS port of your Teleport Proxy Service
or Teleport Enterprise Cloud account (e.g., `teleport.example.com:443` or

Check failure on line 25 in examples/chart/event-handler/README.md

View workflow job for this annotation

GitHub Actions / Lint docs prose style 

[vale] reported by reviewdog 🐶
[messaging.edition-names] "Teleport Enterprise Cloud" is no longer a recognized Teleport edition. Use "Teleport Enterprise (Self-Hosted)" or "Teleport Enterprise (Cloud)" instead. If the hosting type is not important in a given sentence, there is no need to specify it, and you can use "Teleport Enterprise".

Raw Output:
{"message": "[messaging.edition-names] \"Teleport Enterprise Cloud\" is no longer a recognized Teleport edition. Use \"Teleport Enterprise (Self-Hosted)\" or \"Teleport Enterprise (Cloud)\" instead. If the hosting type is not important in a given sentence, there is no need to specify it, and you can use \"Teleport Enterprise\".", "location": {"path": "examples/chart/event-handler/README.md", "range": {"start": {"line": 25, "column": 4}}}, "severity": "ERROR"}
`mytenant.teleport.sh:443`)</td>
<td>string</td>
<td><code>""</code></td>
<td>yes</td>
Expand Down

0 comments on commit 8d20969

Please sign in to comment.