Skip to content

Docs review integrations #577

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

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open

Conversation

novalisdenahi
Copy link
Contributor

Describe the purpose of your pull request

Review and update the following docs:

  • Amplitude
  • Datadogs
  • Jira
  • Monday
  • IntelliJ
  • Zapier
  • Zoho
  • vscode

Requirement checklist

  • I have validated my changes on a test/local environment.
  • I have tested that the code snippets I added work. (Leave unchecked if there are no new code snippets.)
  • I have added my changes to the V1 and V2 documentations.

@novalisdenahi novalisdenahi requested a review from a team as a code owner June 30, 2025 22:11
@novalisdenahi novalisdenahi added the text-review The PR needs a review from the text reviewers team label Jun 30, 2025
Copy link

Head's up @configcat/text-reviewers - someone needs a text review!

Copy link

cloudflare-workers-and-pages bot commented Jun 30, 2025

Deploying configcat-docs with  Cloudflare Pages  Cloudflare Pages

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

View logs

laliconfigcat
laliconfigcat previously approved these changes Jul 7, 2025
Copy link
Contributor

@adams85 adams85 left a comment

Choose a reason for hiding this comment

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

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>.
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
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>.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

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.
Copy link
Contributor

@adams85 adams85 Jul 7, 2025

Choose a reason for hiding this comment

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

"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?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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:

  1. 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.

Comment on lines +59 to +61
:::info
You may have to connect the Zoho Flow Slack app to your Slack subscription if you didn't do it before.
:::
Copy link
Contributor

Choose a reason for hiding this comment

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

❤️

Co-authored-by: adams85 <31276480+adams85@users.noreply.github.com>
novalisdenahi and others added 6 commits July 7, 2025 21:03
Co-authored-by: adams85 <31276480+adams85@users.noreply.github.com>
Co-authored-by: adams85 <31276480+adams85@users.noreply.github.com>
Co-authored-by: adams85 <31276480+adams85@users.noreply.github.com>
Co-authored-by: adams85 <31276480+adams85@users.noreply.github.com>
Co-authored-by: adams85 <31276480+adams85@users.noreply.github.com>
@novalisdenahi novalisdenahi requested a review from adams85 July 7, 2025 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
text-review The PR needs a review from the text reviewers team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants