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

Add documentation for Recombee destination #7049

Merged
merged 8 commits into from
Jan 15, 2025

Conversation

mstieranka
Copy link
Contributor

@mstieranka mstieranka commented Sep 19, 2024

Proposed changes

Hello,

Here at Recombee, we were asked to develop a new version of our existing Recombee AI destination that would use the new Action Destinations framework.

This pull request contains the documentation to this new destination, called Recombee, as well as changes to the old destination (such as deprecating it and changing the wording in some places).

Merge timing

Probably should be merged after the implementation pull request in the action-destinations repository is merged:

segmentio/action-destinations#2429

@mstieranka mstieranka requested a review from a team as a code owner September 19, 2024 15:08
@forstisabella forstisabella added the new-integration Added a new source or destination label Sep 19, 2024
Copy link
Contributor

@tcgilbert tcgilbert left a comment

Choose a reason for hiding this comment

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

just need to add hidden as the destination has not been reviewed yet

Comment on lines 1 to 8
---
title: Recombee (Actions) Destination
versions:
- name: Recombee AI
link: /docs/connections/destinations/catalog/recombee-ai
---
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
---
title: Recombee (Actions) Destination
versions:
- name: Recombee AI
link: /docs/connections/destinations/catalog/recombee-ai
---
---
title: Recombee (Actions) Destination
hidden: true
versions:
- name: Recombee AI
link: /docs/connections/destinations/catalog/recombee-ai
---

Copy link
Contributor

Choose a reason for hiding this comment

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

@tcgilbert does this integration have an id yet?

Copy link
Contributor

Choose a reason for hiding this comment

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

@forstisabella not yet

Copy link
Contributor

@tcgilbert tcgilbert left a comment

Choose a reason for hiding this comment

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

just need to add the id

@seg-atlantis-prod
Copy link

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

@seg-atlantis-prod
Copy link

Error parsing command: EOF found when expecting closing quote

@mstieranka mstieranka requested a review from tcgilbert November 13, 2024 17:26
@seg-atlantis-prod
Copy link

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

@seg-atlantis-prod
Copy link

Error parsing command: EOF found when expecting closing quote

@mstieranka
Copy link
Contributor Author

Hi @tcgilbert @forstisabella , I don't mean to bother, but I fixed all of the issues that you brought up.

Would it be possible to do a final review and merge? Thanks.


By the way, we have also prepared the catalog info from our side, but we haven't yet submitted it for review, since I'm not sure which one of these things to do first.

@forstisabella
Copy link
Contributor

Hi @tcgilbert @forstisabella , I don't mean to bother, but I fixed all of the issues that you brought up.

Would it be possible to do a final review and merge? Thanks.

By the way, we have also prepared the catalog info from our side, but we haven't yet submitted it for review, since I'm not sure which one of these things to do first.

It's no bother!

@seg-atlantis-prod
Copy link

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

@seg-atlantis-prod
Copy link

Error parsing command: EOF found when expecting closing quote

forstisabella
forstisabella previously approved these changes Nov 19, 2024
@tcgilbert
Copy link
Contributor

@forstisabella feel free to merge this

Copy link
Contributor

@tcgilbert tcgilbert left a comment

Choose a reason for hiding this comment

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

@mstieranka please add these changes in regards to removing (Actions) from the title, as discussed in the support ticket

@seg-atlantis-prod
Copy link

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

@seg-atlantis-prod
Copy link

Error parsing command: EOF found when expecting closing quote

@mstieranka
Copy link
Contributor Author

@tcgilbert I committed the suggestions, I also saw there are still some mentions of "Recombee (Actions)" in the text itself, but it seems like a good shorthand for the new destination, so I chose to keep it the way it is now

@tcgilbert
Copy link
Contributor

@mstieranka

I committed the suggestions, I also saw there are still some mentions of "Recombee (Actions)" in the text itself, but it seems like a good shorthand for the new destination, so I chose to keep it the way it is now

I requested changing it in too more spots, as this clarifies what name will actually be shown in the app. But yes, I agree showing (Actions) is a good shorthand everywhere else in the doc

@mstieranka mstieranka changed the title Add documentation for Recombee (Actions) destination Add documentation for Recombee destination Jan 6, 2025

Recombee made the following configuration changes when setting up the new destination:

- Renamed the API Key setting to Private Token: This better reflects the type of token required.
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
- Renamed the API Key setting to Private Token: This better reflects the type of token required.
- **Renamed the API Key setting to Private Token**: This better reflects the type of token required.

@forstisabella forstisabella merged commit 7d190e6 into segmentio:develop Jan 15, 2025
4 checks passed
Copy link
Contributor

Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-integration Added a new source or destination
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants