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

[docs] Tutorial to create storefront component #1982

Merged

Conversation

jcalcaben
Copy link
Contributor

Description

This is a step-by-step tutorial for creating a TagList component for a PWA Studio storefront.

Related Issue

Closes PWA-124

Acceptance

@jimbo

Verification Stakeholders

@jimbo

Specification

Verification Steps

  1. Navigate to the pwa-devdocs directory
  2. Lint the new file: npm run lint src/tutorials/create-tag-list-component/index.md
  3. Verify no linting errors
  4. Build HTML preview: npm run deploy
  5. Navigate to preview site
  6. Navigate to the Tutorials section
  7. Verify new tutorial topic appears in table of content
  8. Navigate to the new topic
  9. Follow instructions for creating a new component
  10. Verify steps result in a working TagList component as described in the tutorial

Screenshots / Screen Captures (if appropriate)

Checklist

  • I have updated the documentation accordingly, if necessary.
  • I have added tests to cover my changes, if necessary.

@jcalcaben jcalcaben added version: Patch This changeset includes backwards compatible bug fixes. docs documentation labels Nov 15, 2019
@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Nov 15, 2019

Messages
📖

Access a deployed version of this PR here. Make sure to wait for the "pwa-pull-request-deploy" job to complete.

📖 DangerCI Failures related to missing labels/description/linked issues/etc will persist until the next push or next nightly build run (assuming they are fixed).
📖

Associated JIRA tickets: PWA-124.

Generated by 🚫 dangerJS against 861e9ae

@jcalcaben jcalcaben marked this pull request as ready for review November 15, 2019 22:29

## Congratulations

You just created a new storefront components using PWA Studio libraries and conventions.
Copy link
Contributor

Choose a reason for hiding this comment

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

🎉

May want to show that the click functionality / url_path works by including a screenshot after click?

Copy link
Contributor

@jimbo jimbo left a comment

Choose a reason for hiding this comment

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

@jcalcaben This is great. Good overview of the process from start to finish.

supernova-at
supernova-at previously approved these changes Nov 22, 2019
Copy link
Contributor

@tjwiebell tjwiebell left a comment

Choose a reason for hiding this comment

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

Hit one copy/paste sample that error'd out, but looks good otherwise. Went ahead and included some other suggestions, but fix the syntax error and this is good to merge.

+ // categories is expected to be an object with a name and url_path string properties
+ categories: arrayOf(
+ shape:({
+ name: string,
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
+ name: string,
+ name: string.isRequired,

@tjwiebell tjwiebell merged commit 9eabf16 into develop Dec 2, 2019
@tjwiebell tjwiebell deleted the jimothy/pwa-124_create-storefront-component-tutorial branch April 28, 2020 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation version: Patch This changeset includes backwards compatible bug fixes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants