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

docs: improve docs on TLD info for connection #119

Closed

Conversation

Tosta-Mista
Copy link

Hello,

This PR to add new documentation examples.

Issue: #118

Copy link
Contributor

@pacificcode pacificcode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sheldonhull sheldonhull changed the title Add new examples of helm configuration docs: improve docs on TLD info for connection Jun 6, 2024
Copy link
Contributor

@sheldonhull sheldonhull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor quick changes. greatly appreciate the contribution!

@@ -26,6 +26,8 @@ The configuration requires a JSON formatted list of Client Credential and Tenant

The name of the credential (such as `app1` or `default`) is used for matching the annontated credential to the right credentials file to use to connect to the connect tenant.

By default, the `tld` is set to `.com` but you can change it by changing `tld` field to `eu` (for example: `"tld": "eu"`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
By default, the `tld` is set to `.com` but you can change it by changing `tld` field to `eu` (for example: `"tld": "eu"`).
If you have a different top level domain, for example `eu` instead of `.com` then look at the [section on supporting alternative tld for guidance](troubleshooting.md#supporting-alternative-tld).

@@ -37,7 +39,8 @@ You can place your temporary config in `.cache/credentials.json` as this is igno
"clientId": "",
"clientSecret": "xxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxx-xxxxx"
},
"tenant": "mytenant"
"tenant": "mytenant",
"tld": "eu"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you revert the changes for the code sample since it's already included in the linked docs? Appreciate it!

@sheldonhull sheldonhull added the documentation Improvements or additions to documentation label Jun 6, 2024
@sheldonhull sheldonhull linked an issue Jun 6, 2024 that may be closed by this pull request
@github-actions github-actions bot added the stale label Jun 7, 2024
@sheldonhull
Copy link
Contributor

to avoid delay/reworking, I went ahead and got the change in, so definitely appreciate bringing up that it wasn't clear enough. cheers!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation (v1.2.2)
3 participants