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

[Doc] css modules tutorial #2341

Merged
merged 9 commits into from
Apr 22, 2020

Conversation

jcalcaben
Copy link
Contributor

Description

This PR revises and publishes the css modules tutorial contributed by @rossmc

Related Issue

Closes PWA-304

Acceptance

any developer

Verification Stakeholders

any developer

Specification

Verification Steps

  1. Navigate to the pwa-devdocs directory: cd pwa-devdocs
  2. Run linting on the new topic: yarn lint src/tutorials/pwa-studio-fundamentals/css-modules/index.md
  3. Verify no linting issues
  4. Start HTML preview server: yarn develop
  5. Navigate to the tutorials section
  6. Verify left nav entry for the new topic and clicking on it takes you to the correct page

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 pkg:pwa-devdocs documentation This pertains to documentation. version: Patch This changeset includes backwards compatible bug fixes. docs documentation labels Apr 16, 2020
@m2-community-project m2-community-project bot added this to Ready for Review in Pull Request Progress Apr 16, 2020
@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Apr 16, 2020

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-304.

Generated by 🚫 dangerJS against 86381d7

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.

One code sample could use some tweaks, but overall looks good 👍

Comment on lines 87 to 93
const {
content,
root,
root_highPriority,
root_lowPriority,
root_normalPriority
} = buttonOverrides;
Copy link
Contributor

Choose a reason for hiding this comment

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

Seems odd to destructure here only to create the exact same object shape below, and with long hand. A better example might be to show the contents of myButtonWrapper.css, and pass it directly without destructuring, which might be more effort than it's worth (maybe don't mock up fake properties, just show those class names exist in that file).

Another reason to destructure would be when names are not exactly the same, but that's not the case here.

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.

Missed a tiny syntax error, but good improvement 👍will approve if you want to commit my suggestion.

…index.md

Co-Authored-By: Tommy Wiebell <twiebell@adobe.com>
@dpatil-magento dpatil-magento merged commit 37cc41e into develop Apr 22, 2020
@dpatil-magento dpatil-magento deleted the jimothy/pwa-304_css-modules-tutorial branch April 22, 2020 15:31
@m2-community-project m2-community-project bot moved this from Changes Requested to Done in Pull Request Progress Apr 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation documentation This pertains to documentation. pkg:pwa-devdocs version: Patch This changeset includes backwards compatible bug fixes.
Development

Successfully merging this pull request may close these issues.

None yet

4 participants