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

USF-1136 Docs for creating experiments #154

Merged
merged 11 commits into from
Dec 18, 2024
Merged

USF-1136 Docs for creating experiments #154

merged 11 commits into from
Dec 18, 2024

Conversation

bdenham
Copy link
Collaborator

@bdenham bdenham commented Dec 18, 2024

This PR adds MVP documentation for how to create A/B experiments in the storefront.

Preview:

PreviewUSF1136

@bdenham bdenham added the documentation Improvements or additions to documentation label Dec 18, 2024
@bdenham bdenham self-assigned this Dec 18, 2024
Copy link
Contributor

@fnhipster fnhipster left a comment

Choose a reason for hiding this comment

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

It might be worth noting what makes this work. Should we mention that the Edge Delivery Services Experimentation plugin comes pre-installed in the Edge Delivery Services for Commerce Boilerplate?

You can find some information about it from the README of the plugin: https://github.com/hlxsites/aem-boilerplate-commerce/blob/main/plugins/experimentation/README.md.

@bdenham
Copy link
Collaborator Author

bdenham commented Dec 18, 2024

Should we mention that the Edge Delivery Services Experimentation plugin comes pre-installed in the Edge Delivery Services for Commerce Boilerplate?

Yeah, definitely. I totally forgot to add info about that. Thanks!

Copy link
Contributor

@jeff-matthews jeff-matthews left a comment

Choose a reason for hiding this comment

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

Approved with some minor suggestions and general feedback for follow up PRs.

src/content/docs/dropins/all/experimenting.mdx Outdated Show resolved Hide resolved
src/content/docs/dropins/all/experimenting.mdx Outdated Show resolved Hide resolved
src/content/docs/dropins/all/experimenting.mdx Outdated Show resolved Hide resolved
<Task>
### Create an variant page for the experiment

Duplicate the original page and make the necessary changes to create a new variant page for the experiment. Update any placeholder labels or content in the variant page to reflect the changes you want to test. For example, you can change the color of a button, update the text of a call-to-action, or rearrange the layout of the page. Save the variant page with a new name to distinguish it from the original page.
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider linking to the page about labels or adding "labels" to the vocabulary section since I think they're unique to drop-in components and that might not be clear to the uninitiated.

src/content/docs/dropins/all/experimenting.mdx Outdated Show resolved Hide resolved
| Title | Cart |
| Robots | noindex,nofollow |
| Experiment | CART001 |
| Experiment Variants | https://marketer-demo---aem-boilerplate-commerce--hlxsites.aem.page/drafts/marketer/cart-new |
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this meant to resolve? If not, let's wrap it in backticks to prevent rendering as a link.

<Task>
### Add the experiment to the original page

Add the experiment to the metadata block of the original page by adding the experiment name and the URL to the experiment page. For example:
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm assuming that this is intentionally vague, but it would be good to follow up with some specific examples of experimentation. There was at least one example in the GA demo, though I don't recall specifically what it was.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

On it!

@bdenham
Copy link
Collaborator Author

bdenham commented Dec 18, 2024

@jeff-matthews and @fnhipster Thanks, guys! It's much improved after your changes and suggestions!

@bdenham bdenham merged commit edc342b into develop Dec 18, 2024
3 checks passed
@bdenham bdenham deleted the USF-1136 branch December 18, 2024 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants