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

Create dropin-starter-template.md #212

Merged
merged 10 commits into from
Mar 16, 2025
Merged

Conversation

supernova-at
Copy link
Contributor

@supernova-at supernova-at commented Mar 12, 2025

Creates the initial draft for using the dropin starter template.

  • Need to verify the steps in this tutorial work for others
  • Need to find a home on the docs site for this to live

Creates the initial draft for using the dropin starter template.
@jcalcaben
Copy link
Contributor

Should we instruct them to add a Container first and put the shared Button component there?

Yes, they should create a container first

npx elsie generate container --pathname <MyContainer>

Then a UI component

npx elsie generate container --pathname <MyContainer>

how do I get my newly created Container to show up in the "Frontend Containers" area?

Update their sandbox environment to render their container that has the UI component (examples/html-host/index.html)

@jcalcaben
Copy link
Contributor

@jeff-matthews or @bdenham

Is this content publicly available anywhere? https://elsie.dev/docs/

I see that it's still behind a permission wall thats based on GitHub users. If not, how would external developers know how to work with the SDK components?

@jeff-matthews
Copy link
Contributor

@jeff-matthews or @bdenham

Is this content publicly available anywhere? https://elsie.dev/docs/

I see that it's still behind a permission wall thats based on GitHub users. If not, how would external developers know how to work with the SDK components?

@jcalcaben, it's not public yet. we plan to integrate the SDK storybook output from the elsie site with the current docs site to create a unified experience. last i heard, we need to do this for the April 8th marketing release window.

i assume that also means we should figure out how the content in this PR fits with that. @bdenham is going to look into it when he wraps up the summit lab workbook.

supernova-at and others added 3 commits March 13, 2025 15:20
Updates instructions to include generating a component, a container, and adding the container to the sandbox env.
Copy link
Contributor

@jcalcaben jcalcaben left a comment

Choose a reason for hiding this comment

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

Overall this is good enough as a starting point. We'll probably need additional in depth guides on dropin development best practices.

I think we need to clean up the sandbox index.html file so that there is less to remove or comment out to get things working, but that can be its own PR.

Copy link
Collaborator

@bdenham bdenham 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 acceptance of suggested changes. Nice job, Andy!

@devpatil7
Copy link

devpatil7 commented Mar 14, 2025

@supernova-at Please add supported Node versions as Maintenance (20) and Active (22)

Incorporates change suggestions

## How to Use the Adobe Commerce Drop-in Template

Note: Supported Node versions are: Maintenance (v20) and Active (v22).
Copy link
Contributor Author

@supernova-at supernova-at Mar 14, 2025

Choose a reason for hiding this comment

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

Note: new content added here per #212 (comment).

supernova-at and others added 2 commits March 14, 2025 12:35
@bdenham bdenham enabled auto-merge March 16, 2025 07:26
@bdenham bdenham merged commit e36580b into commerce-docs:develop Mar 16, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants