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.

Sign up for GitHub

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

Jump to bottom

Integrations v2 update #439

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

Integrations v2 update #439

wants to merge 18 commits into from

Conversation

novalisdenahi
Copy link
Contributor

Description

Jira / Trello/ monday.com and VSCode integration docs update. Change linked images and text to be up-to-date with V2.

V1 docs will be updated after the V2 versions are finalized.

Trello card

Trello ticket

Notes for QA

The description and the images for the 4 integrations should not contain any V1 information.

Requirement checklist

  • I have validated my changes on a test/local environment.
  • I have added my changes to the V1 and V2 documentations.
  • I have checked the SNYK/Dependabot reports and applied the suggested changes.
  • (Optional) I have updated outdated packages.

@cloudflare-pages Cloudflare Pages
Copy link

cloudflare-pages bot commented May 17, 2024 •
edited
Loading

Deploying configcat-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3097186
Status: ✅  Deploy successful!
Preview URL: https://157ff99c.docs-xmy.pages.dev
Branch Preview URL: https://integrations-v2-update.docs-xmy.pages.dev

View logs

sigewuzhere
sigewuzhere reviewed Jun 4, 2024
View reviewed changes
website/docs/integrations/jira.mdx Outdated
4. Click authorize.

> Every Jira user should authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Jira Cloud Plugin.
:::info
Every Jira user should authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Jira Cloud Plugin.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Every Jira user should authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Jira Cloud Plugin.
Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Jira Cloud Plugin.

just guessing

website/docs/integrations/jira.mdx Outdated
### Linking existing feature flags

1. Navigate to any Issue on your Jira board.
2. Open `ConfigCat Feature Flag` issue context.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
2. Open `ConfigCat Feature Flag` issue context.
2. Open the `ConfigCat Feature Flag` issue context.

website/docs/integrations/jira.mdx Outdated
1. Navigate to any Issue on your Jira board.
2. Open `ConfigCat Feature Flag` issue context.
3. On the `Link existing` tab select a ConfigCat Product, Config, Environment and a Feature Flag to be linked to your issue.
4. When linked, you can turn your features On / Off right from this Issue.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
4. When linked, you can turn your features On / Off right from this Issue.
4. When linked, you can manage the selected feature flag from this Issue.

website/docs/integrations/jira.mdx Outdated

<img src="/docs/assets/jira/link-existing.gif" className="zoomable" alt="Linking existing feature flags in Jira Cloud Plugin" />

### View and Edit linked feature flags

1. Open an Issue on your Jira board with linked feature flag.
2. You can see the linked feature flags in the `Feature Flag (ConfigCat)` issue section.
3. You can turn your features On / Off right from this Issue.
Copy link
Member

Choose a reason for hiding this comment

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

same as above

website/docs/integrations/jira.mdx Outdated
4. You can add new Targeting Rules, target a new segment or target a percentage of users.
5. You can remove Targeting Rules as well.
6. To see the feature flag on the ConfigCat Dashboard just use the `Open in ConfigCat` link.
4. You can add new Targeting Rules with User, Segment or Prerequisite conditions with large selection of Comparators.
Copy link
Member

Choose a reason for hiding this comment

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

might be a good idea to to link connecting docs pages

website/docs/integrations/jira.mdx Outdated
1. Open a version in the project Release Hub to see the related issues feature flag status.
2. Click it for more detailed dialog.
:::info
The plugin doesn't implement the Releases - Create/Connect feature flag actions. However, it provides the same actions without the necessity of navigating outside the Jira instance.
Copy link
Member

Choose a reason for hiding this comment

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

Let's discuss this in person. I'm not sure what it means.

sigewuzhere
sigewuzhere previously approved these changes Jun 10, 2024
View reviewed changes
@novalisdenahi
Copy link
Contributor Author

@sigewuzhere The V1 docs are updated

sigewuzhere
sigewuzhere previously approved these changes Jun 20, 2024
View reviewed changes
@novalisdenahi novalisdenahi marked this pull request as ready for review June 21, 2024 09:48
@novalisdenahi novalisdenahi requested a review from a team as a code owner June 21, 2024 09:48
zoltan-david
zoltan-david reviewed Jul 18, 2024
View reviewed changes
website/docs/integrations/jira.mdx

## Installation
Turn features On/Off right from a linked Issue on your Jira board. You can also easily modify the linked flags to edit or add new Targeting or Percentage Rules.
Copy link
Member

Choose a reason for hiding this comment

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

Ez a mondat az értékeajánlat. Az a szerepe, hogy megértse a user, hogy mire tudná használni ezt az integrációt. Ezért ennek a mondatnak a leírás legelején van értelme. Az Installation szekcióban szerintem nincsen sok haszna már.

Azt jvaslom, hogy mozgassuk vissza a doksi elejére. Akár az új kezdőmondat elé vagy mögé.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

A doksi elején van. Pont az installation szekció került hátrább.

website/docs/integrations/jira.mdx

## Usage

### Linking existing feature flags
Copy link
Member

Choose a reason for hiding this comment

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

Általában véve azért lenne jobb ha a “Link existing” use case előbb szerepelne, mint a “Create new”, mert a “Link existing” sokkal gyakoribb.

Ugyanakkor itt a ConfigCat doksiban megértem ezt a sorrendet is, de más helyeken pl. a JIRA oldalán mindenképpen a "Link existing" legyen előbb.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Szerintem kiegyezhetünk midnenütt a link existing és create sorrendben. Egységesen appokban és doksiban is. Módsoítom ennek megfelően.

website/docs/integrations/jira.mdx Outdated
1. Open an Issue on your Jira board with linked feature flag.
2. Check the `Releases` field values in the issue Details section to see the linked feature flags status in the Issue.
3. Click it for more detailed dialog.
1. Open a version in the project Release Hub to see the related issues feature flag status.
Copy link
Member

Choose a reason for hiding this comment

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

Itt a Release Hub-ot hívjuk Jira Release Hub-nak légyszi.
Az az alapelv, hogy sok userünk nem ismeri mélyen sem a Jirat, sem a ConfigCatet.
Nekik segítünk azzal, hogy megnevezzük melyik toolban kezdjen el keresgélni.
Szóval a contextust (ConfigCat vagy Jira) áltlában megnevezzük legalább egyszer, legalább a felsorolások első pontjaiban.

website/docs/integrations/monday.mdx Outdated
3. Add the ConfigCat Feature Flags monday app to your item.
4. In order to use ConfigCat Feature Flags you have to authorize first with your ConfigCat Public API credentials.
5. Get your ConfigCat Public API credentials: https://app.configcat.com/my-account/public-api-credentials
2. Open one of your boards on monday and click on an Item.
Copy link
Member

Choose a reason for hiding this comment

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

Ez biztosan "on" monday, és nem "in" monday?
Mert szerintem in "in" Jira, és biztosan nem "on" Jira.

Az "on monday" az szerintem azt jelenti, hogy "hétfőn".

Ennek ellenére, ha a Monday-esek "on monday"-ként szoktak beszélni a saját tooljukról, akkor felőlem maradhat így. Különben szerintem érdemes "in"-re cserélni.

Copy link
Member

Choose a reason for hiding this comment

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

Esetleg lehetne on monday.com

website/docs/integrations/trello.mdx

## Installation
Turn features On/Off right from a linked card on your Trello board. You can also easily modify the linked flags to edit or add new Targeting or Percentage Rules.
Copy link
Member

Choose a reason for hiding this comment

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

Ez is egy értékajánlat, itt is azt javaslom, hogy ne az Installation szekcióban legyen, hanem a doksumentum elején az első egy-két mondatban.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

A doksi elején van. Pont az installation szekció került hátrább.

website/docs/integrations/vscode.mdx Outdated

1. Search for ConfigCat Feature Flags at the Extensions page.
1. Search for ConfigCat Feature Flags on the Extensions page.
Copy link
Member

Choose a reason for hiding this comment

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

Javaslom, hogy az első pontban mindig nevezzük meg a toolt (bár látom, hogy itt a cím sokat segít).

Valami ilyet javaslok:
In Visual Studio Code, open the Extensions page, and search for ConfigCat Feature Flags.

website/docs/integrations/vscode.mdx Outdated
### Advanced

If you are trying to use the ConfigCat Feature Flags extension for Visual Studio Code with a `dedicated hosted`/[on-premise](https://configcat.com/on-premise/) ConfigCat instance, you can specify your custom urls by executing the `Preferences: Open Workspace Settings` command from the Command Palette and search for `Extensions/ConfigCat` or clicking the manage button on the ConfigCat Feature Flags extension's page. Important settings:
If you are trying to use the ConfigCat Feature Flags extension for Visual Studio Code with a `dedicated hosted`/[on-premise](https://configcat.com/on-premise/) ConfigCat instance. In that case, you can specify your custom URLs by executing the `Preferences: Open Workspace Settings` command from the Command Palette and searching for `Extensions/ConfigCat` or clicking the manage button on the ConfigCat Feature Flags extension's page. Important settings:
Copy link
Member

Choose a reason for hiding this comment

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

Szuper, hogy kettétörted azt a nagy mondatot!

Viszont így az első mondatnak önmagában nincs igazi tartalma.

És én "a you are trying to use" helyett is "you use"-t használnék, mert a nem anyanelyvi angoloknak sokat segít.

Valami ilyesmit javaslok:

This section is for you if you use a dedicated hosted/[on-premise](https://configcat.com/on-premise/) ConfigCat instance. In that case, you must specify your custom ConfigCat URLs in Visual Studio Code. You can do that by executing the Preferences: Open Workspace Settingscommand from the Command Palette and searching forExtensions/ConfigCat` or clicking the manage button on the ConfigCat Feature Flags extension's page. Important settings:

website/docs/integrations/vscode.mdx Outdated

## Usage of ConfigCat Feature Flags Views

The ConfigCat Feature Flags Views can be opened by clicking the ConfigCat Feature Flags icon on the Activity Bar. There are three different views.
Copy link
Member

Choose a reason for hiding this comment

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

Én itt is kiírnaám, hogy a "Visual Studio Code" az "Activity Bar" környékére.

website/docs/integrations/vscode.mdx Outdated

### Feature Flags & Settings View

After you successfully connect a Config to your Workspace from the Feature Flags & Settings View, you can:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
After you successfully connect a Config to your Workspace from the Feature Flags & Settings View, you can:
After you successfully connect your ConfigCat Config to your Visual Studio Code Workspace, open the Feature Flags & Settings View and:

website/docs/integrations/vscode.mdx Outdated

### or install from VSIX file
### Install from VSIX file

1. Open [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags) at Visual Studio Marketplace.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
1. Open [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags) at Visual Studio Marketplace.
1. Visual Studio Marketplace, open the [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Add In to the beginning

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zoltan-david zoltan-david zoltan-david left review comments

@sigewuzhere sigewuzhere sigewuzhere left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@novalisdenahi @zoltan-david @sigewuzhere