Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[doc] Update Venia setup doc #1809

Merged
merged 1 commit into from
Sep 30, 2019
Merged

Conversation

jcalcaben
Copy link
Contributor

Description

Updates the Venia setup docs.
Specifically, it switches step 3 & 4 to align with what the project recommends when running the CLI commands.

Related Issue

Closes #ISSUE_NUMBER.

Acceptance

@awilcoxa

Verification Stakeholders

@awilcoxa

Specification

Verification Steps

  1. Navigate to pwa-devdocs
  2. Run linter on changed file: npm run lint src/venia-pwa-concept/setup/index.md
  3. Verify no linting errors.
  4. Run HTML preview server: npm run develop
  5. Navigate to /venia/pwa-concept/setup page.
  6. Follow steps on a fresh local instance of the repo
  7. Verify steps result in a running instance of Venia.

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 the version: Patch This changeset includes backwards compatible bug fixes. label Sep 30, 2019
@jcalcaben jcalcaben added this to the Docs Improvements Phase 2 milestone Sep 30, 2019
@PWAStudioBot
Copy link
Contributor

Fails
🚫

No linked issue found. Please link a relevant open issue by adding the text "closes #<issue_number>" or including the associated JIRA ID in your PR.

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

Generated by 🚫 dangerJS against 3db35a7

Copy link
Contributor

@cherdman cherdman left a comment

Choose a reason for hiding this comment

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

Ship it!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
version: Patch This changeset includes backwards compatible bug fixes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants