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.

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

[Doc] FAQ page #2358

Merged
merged 7 commits into from
Apr 30, 2020
Merged

[Doc] FAQ page #2358

merged 7 commits into from
Apr 30, 2020

Conversation

jcalcaben
Copy link
Contributor

Description

This PR creates a page of curated questions community member commonly ask about the project.

Related Issue

Closes #PWA-545

Acceptance

Developers
Maintainers

Verification Stakeholders

Developers
Maintainers

Specification

Verification Steps

  1. Navigate to the pwa-devdocs project: cd pwa-devdocs
  2. Run linter on new topic: yarn lint src/frequently-asked-questions/index.md
  3. Verify no linting issues
  4. Start the HTML preview server yarn develop
  5. Verify site builds and runs
  6. Navigate to the Getting Started section
  7. Verify Frequently Asked Questions entry on the left nav
  8. Click on the entry
  9. Verify it loads 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. docs documentation labels Apr 24, 2020
@m2-community-project m2-community-project bot added this to Ready for Review in Pull Request Progress Apr 24, 2020
@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Apr 24, 2020 •
edited

Fails
🚫 A version label is required. A maintainer must add one.
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-545.

Generated by 🚫 dangerJS against 801395f

@jcalcaben jcalcaben marked this pull request as ready for review April 28, 2020 19:43
supernova-at
supernova-at previously approved these changes Apr 29, 2020
View reviewed changes
Copy link
Contributor

@supernova-at supernova-at left a comment

Choose a reason for hiding this comment

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

Minor suggestions but overall great!

I think this will be very useful to the community 💪

pwa-devdocs/src/frequently-asked-questions/index.md Outdated Show resolved Hide resolved
pwa-devdocs/src/frequently-asked-questions/index.md Outdated Show resolved Hide resolved
@m2-community-project m2-community-project bot moved this from Ready for Review to Reviewer Approved in Pull Request Progress Apr 29, 2020
@dpatil-magento
Copy link
Contributor

Verification steps look good.

@dpatil-magento dpatil-magento merged commit 081ba30 into develop Apr 30, 2020
@dpatil-magento dpatil-magento deleted the jimothy/pwa-545_faq-page branch April 30, 2020 16:22
@m2-community-project m2-community-project bot moved this from Reviewer Approved to Done in Pull Request Progress Apr 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@supernova-at supernova-at supernova-at approved these changes

Assignees

@supernova-at supernova-at

Labels
docs documentation documentation This pertains to documentation. pkg:pwa-devdocs
Projects
Pull Request Progress
Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@jcalcaben @PWAStudioBot @dpatil-magento @supernova-at