Skip to content

Add instructions on package installation and usage #12576

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
Merged
jeherve merged 7 commits into from
Jun 6, 2019
Merged

Add instructions on package installation and usage #12576

jeherve merged 7 commits into from
Jun 6, 2019

Conversation

@eliorivero
Copy link
Contributor

@eliorivero eliorivero commented Jun 5, 2019

Initial info about Composer and how to install it, and about the packages: how to require them, install them and use them.

Changes proposed in this Pull Request:

  • adds a Readme with info about Composer and the packages

Proposed changelog entry for your changes:

  • Not needed.

@eliorivero eliorivero added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Review This PR is ready for review. [Focus] Jetpack DNA labels Jun 5, 2019
@eliorivero eliorivero added this to the 7.5 milestone Jun 5, 2019
@eliorivero eliorivero requested a review from a team June 5, 2019 15:52
@eliorivero eliorivero self-assigned this Jun 5, 2019
@eliorivero eliorivero force-pushed the add/packages-readme branch from dac6d7e to 6aaf4bd Compare June 5, 2019 15:54
@jetpackbot
Copy link
Collaborator

jetpackbot commented Jun 5, 2019 •
edited
Loading

Warnings
⚠️ "Testing instructions" are missing for this PR. Please add some

This is an automated check which relies on PULL_REQUEST_TEMPLATE. We encourage you to follow that template as it helps Jetpack maintainers do their job. If you think 'Testing instructions' or 'Proposed changelog entry' are not needed for your PR - please explain why you think so. Thanks for cooperation 🤖

Generated by 🚫 dangerJS against e63601d

jeherve
jeherve previously requested changes Jun 5, 2019
View reviewed changes
@jeherve
Copy link
Member

jeherve commented Jun 5, 2019

It may be worth basing that branch against feature/jetpack-packages instead of master, so we merge it with the rest of the first sprint on Friday?

@eliorivero eliorivero force-pushed the add/packages-readme branch from 6aaf4bd to 09fa4a1 Compare June 5, 2019 17:03
@eliorivero eliorivero requested a review from a team as a code owner June 5, 2019 17:03
@matticbot
Copy link
Contributor

matticbot commented Jun 5, 2019

Caution: This PR has changes that must be merged to WordPress.com
Hello eliorivero! These changes need to be synced to WordPress.com - If you 're an a11n, please commandeer, review, and approve D29122-code before merging this PR. Thank you!

@eliorivero
Copy link
Contributor Author

eliorivero commented Jun 5, 2019

Rebased against feature/jetpack-packages

aldavigdis
aldavigdis reviewed Jun 5, 2019
View reviewed changes
@eliorivero
Move content about installing Composer to the doc regarding developme…
c91ab19 
…nt environment. Add a pointer to that section in the packages' readme
@eliorivero eliorivero changed the base branch from master to feature/jetpack-packages June 5, 2019 17:34
@eliorivero eliorivero dismissed jeherve’s stale review June 5, 2019 18:13

Changes made

@eliorivero eliorivero force-pushed the add/packages-readme branch from b2bafc9 to 1d2153c Compare June 5, 2019 18:35
jeherve
jeherve requested changes Jun 5, 2019
View reviewed changes
Copy link
Member

@jeherve jeherve left a comment

Choose a reason for hiding this comment

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

This is looking good. I have a few minor comments, and since we now have an exhaustive "Installing Composer" I would link to it as a new third step here:

jetpack/docs/development-environment.md

Line 49 in 1d2153c

3. Install yarn. Please, refer to yarn's [Installation Documentation](https://yarnpkg.com/docs/install/). 

3. [Install Composer](#installing-composer).
4. Install yarn. Please, refer to yarn's [Installation Documentation](https://yarnpkg.com/docs/install/).

5. Make sure the Jetpack plugin is active and run

	```
	$ yarn build
	```

	This will install npm dependencies and then build the files.

6. Open `/wp-admin/admin.php?page=jetpack` in your browser.

Once that's done, merge it!

@jeherve jeherve added [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. and removed [Status] Needs Review This PR is ready for review. labels Jun 5, 2019
jeherve
jeherve approved these changes Jun 6, 2019
View reviewed changes
Copy link
Member

@jeherve jeherve left a comment

Choose a reason for hiding this comment

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

Looking good to me. Merging.

@jeherve jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Jun 6, 2019
@jeherve jeherve merged commit 1396c15 into feature/jetpack-packages Jun 6, 2019
@jeherve jeherve deleted the add/packages-readme branch June 6, 2019 09:12
@matticbot matticbot added [Status] Needs Changelog and removed [Status] Ready to Merge Go ahead, you can push that green button! labels Jun 6, 2019
@tyxla
Copy link
Member

tyxla commented Jun 6, 2019

Great work 👏

@tyxla tyxla mentioned this pull request Jun 6, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jeherve jeherve jeherve approved these changes

+1 more reviewer

@aldavigdis aldavigdis aldavigdis left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@eliorivero eliorivero

Labels

[Focus] Jetpack DNA [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it

Projects

None yet

Milestone

7.5

Development

Successfully merging this pull request may close these issues.

7 participants

@eliorivero @jetpackbot @jeherve @matticbot @tyxla @aldavigdis