Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Improve the docs for Avo #6075

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
Closed
wants to merge 2 commits into from
Closed

Improve the docs for Avo #6075

wants to merge 2 commits into from

Conversation

bjornj12
Copy link
Contributor

Proposed changes

Updating the Docs for Avo, adding more intro and fixing the copy for some steps after feedback.

Merge timing

Related issues (optional)

Based on updates from here:
segmentio/action-destinations#1885

@bjornj12 bjornj12 requested a review from a team as a code owner February 16, 2024 14:41
@bjornj12 bjornj12 requested review from pwseg and removed request for a team February 16, 2024 14:41
@bjornj12
Copy link
Contributor Author

hey @forstisabella! Adding a little bit of improvements to the docs after review on the public page 🙌

I have some questions though about the auto generated content

Actions

How are the supported actions here detected? Currently we only support Track events, How would I change this to make sure it reflects that?
image

Destination Settings

In our Destination, App Version property is clearly set to required: false, but somehow we're detected here as Required
How do I get it changed to Optional?
image

Engage

What is this engage? it is coming in because the docs say we support Identify? will it disappear if we do not support identify?
image

Thanks in advance! 🙏

@bjornj12 bjornj12 changed the title Improve the docs Improve the docs for Avo Feb 19, 2024
@bjornj12
Copy link
Contributor Author

bumping this @forstisabella, any chance to get a quick review on these things? we are hyping this this week 🙌

@forstisabella
Copy link
Contributor

forstisabella commented Feb 20, 2024 •
edited
Loading

hi @bjornj12 - thanks for reaching out again about this! All of this information is pulled from Segment's Public API. When I look up the Avo destination using its ID (65c2465d0d7d550aa8e7e5c6), I get the following information about supported methods:

"supportedMethods": {
                "track": true,
                "pageview": true,
                "identify": true,
                "group": true,
                "alias": true
            },

and the following for the appVersionPropertyName setting:

"name": "appVersionPropertyName",
                    "type": "string",
                    "defaultValue": "",
                    "description": "If you send a custom event property on all events that contains the app version, please enter the name of that property here (e.g. “app_version”). If you do not have a custom event property for the app version, please leave this field empty.",
                    "required": true,
                    "label": "App Version Property"
                },

I see that the PR you opened in the actions-destinations repo was only recently merged - when we re-run our catalog as part of our regular docs release process, the appVersionPropertyName will programmatically be updated to be 'Optional".

However, to update the supported methods, you'd need to reach out to the folks that run the partner portal.

@tcgilbert - what would Björn need to do to update the supported methods?

In terms of Engage support - that's inferred from platform support. Given that the destination supports the server platform, the site infers that it can support Engage. If that isn't the case, please let me know and I can open an additional PR to add the destination ID to an override list to remove this section.

If you have any additional questions, please reach out!

@tcgilbert
Copy link
Contributor

How are the supported actions here detected? Currently we only support Track events, How would I change this to make sure it reflects that?

@bjornj12 I updated this to only show Track. This will be reflected when the docs page next rebuilds. If you need this updated in the future, please reach out to [email protected].

@bjornj12
Copy link
Contributor Author

Great @forstisabella , @tcgilbert thanks!

re: appVersionPropertyName

This is the config field in the PR that was merged 🤔 Will it automatically detect in next build?

 appVersionPropertyName: {
        label: 'App Version Property',
        description:
          'If you send a custom event property on all events that contains the app version, please enter the name of that property here (e.g. “app_version”). If you do not have a custom event property for the app version, please leave this field empty.',
        type: 'string',
        required: false
      }

Re: Engage

Given that the destination supports the server platform, the site infers that it can support Engage.

Not sure whether we support it or not. If it's inferred by server functions, I guess we do?

Is it possible to get this PR in a speedy review and ship and we iterate in different PR if the app Version is not changing to optional?
We are hyping these docs up in a blog post later today 🙌 pushing everyone to segment as the easiest way to install the Inspector for Avo 🚀

forstisabella
forstisabella approved these changes Feb 20, 2024
View reviewed changes
src/connections/destinations/catalog/avo/index.md

Without app versions, the inspector has no way of differentiating between old and new releases, and might surface irrelevant issues based on old releases. [Learn more about how Inspector uses releases](https://www.avo.app/docs/inspector/inspector-issues-view#release-and-source-breakdown)

For most mobile sources, we will automatically fetch the app version from Segment Context. If you have an event property describing the app release version of your source (“E.g “app_version”) you can provide it under App Version.
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
For most mobile sources, we will automatically fetch the app version from Segment Context. If you have an event property describing the app release version of your source (“E.g “app_version”) you can provide it under App Version.
For most mobile sources, Avo automatically fetches the app version from Segment Context. If you have an event property describing the app release version of your source (“E.g “app_version”) you can provide it under App Version.

src/connections/destinations/catalog/avo/index.md
{% include content/plan-grid.md name="actions" %}

## Supported methods

### Track events

The Avo destination supports Track events.
The Avo destination supports `Track` events.
Copy link
Contributor

Choose a reason for hiding this comment

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

When discussing Segment methods outside of code snippets, please capitalize them and avoid stylizing them like inline code.

Suggested change
The Avo destination supports `Track` events.
The Avo destination supports Track events.

src/connections/destinations/catalog/avo/index.md

App Version Property is an optional **(but recommended!)** field. Having accurate app release versions in Avo Inspector allows you to see how events change across releases. This will help you identify which releases an issue is impacting, and monitor for regressions in future releases after an issue has been resolved.

Without app versions, the inspector has no way of differentiating between old and new releases, and might surface irrelevant issues based on old releases. [Learn more about how Inspector uses releases](https://www.avo.app/docs/inspector/inspector-issues-view#release-and-source-breakdown)
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
Without app versions, the inspector has no way of differentiating between old and new releases, and might surface irrelevant issues based on old releases. [Learn more about how Inspector uses releases](https://www.avo.app/docs/inspector/inspector-issues-view#release-and-source-breakdown)
Without app versions, the inspector has no way of differentiating between old and new releases, and might surface irrelevant issues based on old releases. Learn more about how Inspector uses releases in [Avo's documentation](https://www.avo.app/docs/inspector/inspector-issues-view#release-and-source-breakdown){:target="\_blank”}.

src/connections/destinations/catalog/avo/index.md

#### App Version Property

App Version Property is an optional **(but recommended!)** field. Having accurate app release versions in Avo Inspector allows you to see how events change across releases. This will help you identify which releases an issue is impacting, and monitor for regressions in future releases after an issue has been resolved.
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
App Version Property is an optional **(but recommended!)** field. Having accurate app release versions in Avo Inspector allows you to see how events change across releases. This will help you identify which releases an issue is impacting, and monitor for regressions in future releases after an issue has been resolved.
App Version Property is an optional **(but recommended!)** field. Having accurate app release versions in Avo Inspector allows you to see how events change across releases. This helps you identify which releases an issue is impacting, and monitor for regressions in future releases after an issue has been resolved.

src/connections/destinations/catalog/avo/index.md
#### Environment

Environment describes which app environment the source is sent from, `Development | Staging | Production`.
Avo only generates issues for events in the `Production` environment, but you can see the event shapes for staging and development environments to make sure they are implemented correctly.
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
Avo only generates issues for events in the `Production` environment, but you can see the event shapes for staging and development environments to make sure they are implemented correctly.
Avo only generates issues for events in your `Production` environment, but you can see the event shapes for staging and development environments to make sure they are implemented correctly.

src/connections/destinations/catalog/avo/index.md
3. Select Avo from the list of destinations, then click **Add destination**.
4. Select a source to connect to Avo (Actions) and click **Next**.
5. Enter a name for your Avo (Actions) destination and click **Create destination**.
3. Select [Avo](https://app.segment.com/goto-my-workspace/destinations/catalog/actions-avo) from the list of destinations, then click **Add destination**.
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
3. Select [Avo](https://app.segment.com/goto-my-workspace/destinations/catalog/actions-avo) from the list of destinations, then click **Add destination**.
3. Select [Avo](https://app.segment.com/goto-my-workspace/destinations/catalog/actions-avo){:target="\_blank”} from the list of destinations, then click **Add destination**.

@forstisabella
Copy link
Contributor

Great @forstisabella , @tcgilbert thanks!

re: appVersionPropertyName

This is the config field in the PR that was merged 🤔 Will it automatically detect in next build?

 appVersionPropertyName: {
        label: 'App Version Property',
        description:
          'If you send a custom event property on all events that contains the app version, please enter the name of that property here (e.g. “app_version”). If you do not have a custom event property for the app version, please leave this field empty.',
        type: 'string',
        required: false
      }

Re: Engage

Given that the destination supports the server platform, the site infers that it can support Engage.

Not sure whether we support it or not. If it's inferred by server functions, I guess we do?

Is it possible to get this PR in a speedy review and ship and we iterate in different PR if the app Version is not changing to optional? We are hyping these docs up in a blog post later today 🙌 pushing everyone to segment as the easiest way to install the Inspector for Avo 🚀

It should automatically update when the catalog updates, yes!

I've completed a review - please take a look at my feedback so we can get this merged today!

@forstisabella forstisabella mentioned this pull request Feb 20, 2024
Merged
@forstisabella
Copy link
Contributor

Hi @bjornj12 - looks like your PR has branch protections, so I'm unable to edit it directly. I've opened another PR with the same information: #6092. I'm closing this PR for now!

@bjornj12
Copy link
Contributor Author

You are a hero @forstisabella ! 🙌

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

@forstisabella forstisabella forstisabella approved these changes

@pwseg pwseg Awaiting requested review from pwseg pwseg is a code owner automatically assigned from segmentio/segment-doc-team

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
@bjornj12 @forstisabella @tcgilbert