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

[Documentation] Move Venia sample data installation into its own topic #436

Closed
jcalcaben opened this issue Oct 30, 2018 · 0 comments
Closed
Assignees
Milestone

Comments

@jcalcaben
Copy link
Contributor

This issue is for the following packages:

[ ] venia-concept
[ ] pwa-buildpack
[ ] peregrine
[x] pwa-devdocs
[ ] upward-js
[ ] upward-spec

This issue is a:

[ ] Bug
[ ] Feature suggestion
[x] Documentation issue
[ ] Other (Please Specify)

Description

Currently the Venia setup instructions contain a section about installing the Venia sample data into a local instance of Magento. Since the UPWARD implementation, having a running instance of Magento is optional and makes instructions for installing the sample data seem out of place.

Expected result:

A new topic that is focused on installing the Venia sample data into Magento.

Possible solutions:

Create a new doc topic and move the sample data installation instructions over from the Setup topic.

  • Include prerequisites, including mention of PHP 7.2 incompatibility on one of the modules. Must use 7.1.
  • Revise instructions so that it has the user copying the bash script from the venia project instead of showing the content for the bash script.
@jcalcaben jcalcaben added this to the Sprint 29 milestone Oct 30, 2018
@jcalcaben jcalcaben self-assigned this Oct 30, 2018
@jcalcaben jcalcaben added pkg:pwa-devdocs for-grooming Candidate for team grooming on Friday with Community. labels Oct 30, 2018
@zetlen zetlen removed the for-grooming Candidate for team grooming on Friday with Community. label Nov 2, 2018
jcalcaben added a commit that referenced this issue Nov 12, 2018
* #436 Create topic for installing Venia sample data

* #436 update setup topic to remove venia sample data install section
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants