Docs review integrations #577
Conversation
novalisdenahi
added
the
text-review
|
Head's up @configcat/text-reviewers - someone needs a text review! |
Deploying configcat-docs with
|
| Latest commit: |
5b695e4
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://af828324.docs-xmy.pages.dev |
| Branch Preview URL: | https://docs-review-integrations.docs-xmy.pages.dev |
There was a problem hiding this comment.
FYI, according to the new text guidelines, text quoted from the UI should be bold. This style is reserved for code-like text.
The guidelines are not in effect yet, so I'd rather not block the PR with this. But it would be nice to change the text formatting sooner or later to match it.
| 2. Navigate to `App Connections` from the side menu. | ||
| 3. Click on `Add connection` and search for `ConfigCat` in the `Add new connection` dialog. | ||
| 4. Click on `Add connection` button to connect ConfigCat. | ||
| 5. Generate a Public API credential at <a href="https://app.configcat.com/my-account/public-api-credentials" target="_blank">ConfigCat Dashboard</a>. |
There was a problem hiding this comment.
| 5. Generate a Public API credential at <a href="https://app.configcat.com/my-account/public-api-credentials" target="_blank">ConfigCat Dashboard</a>. | |
| 5. Generate a Public Management API credential at <a href="https://app.configcat.com/my-account/public-api-credentials" target="_blank">ConfigCat Dashboard</a>. |
There was a problem hiding this comment.
In this case, maybe it would be better to use the same line from other docs:
5. Get your ConfigCat Public API credentials from ConfigCat Dashboard/Public Management API credentials.
There was a problem hiding this comment.
I'm fine with that too.
However, the correct name of this ConfigCat service is "ConfigCat Public Management API". I'd suggest using that here and in other docs as well. ("ConfigCat Public API" is somewhat vague: the Dashboard API is public as well...)
| 1. Create a new Trigger. | ||
| 1. Select `ConfigCat` app, `Feature Flag & Setting value changed` as Trigger event and the connected account. | ||
| 1. Select the Product in which you want to get notified about the Feature Flag or Setting value changes. | ||
| 1. Select optionally Config and/or Environment to specify more of the notification. |
There was a problem hiding this comment.
"Select optionally Config and/or Environment to specify more of the notification."
What does this mean? Is this selection some kind of filter for the notifications?
There was a problem hiding this comment.
Yeah. Basically, there are 3 selects. Product is required. The Config and Environment are optional and make the notification more specific.
Maybe it should look like this:
- Select the Product in which you want to get notified about the Feature Flag or Setting value changes.
1.1 To specify the notification more, select Config and/or Environment.
There was a problem hiding this comment.
Ah, ok.
I think my problem is with the word "specify". I'm not sure if it's correct in this context.
I'd suggest something like this:
1. Select the Product for which you want to receive notifications about Feature Flag or Setting changes.
1. For more specific notifications, select a Config and/or Environment.
Co-authored-by: adams85 <[email protected]>
Co-authored-by: adams85 <[email protected]>
Co-authored-by: adams85 <[email protected]>
Co-authored-by: adams85 <[email protected]>
Co-authored-by: adams85 <[email protected]>
Co-authored-by: adams85 <[email protected]>
Describe the purpose of your pull request
Review and update the following docs:
Requirement checklist