Playground repositories overview #1270
Conversation
|
@flexseth Thank you! I left some notes but it looks solid otherwise |
Oh I thought you've mentioned submitting too many files in this PR on Slack. My bad if you intended to keep that file here. That being said, smaller PRs are typically easier to discuss. |
|
As long as the issue template is reviewed and included - all good. Just wanting to guide issues if possible In the future I'll do separate PRs, also thanks for the tip on how to keep the branches from being submitted into the same PR! And, how to correctly switch branches- maybe the most important tip I've received about Git!! |
Surely! My machine crashed at the end of last week so I got set back a little bit. Should have something ready by the end of the weekend |
|
Hi @flexseth, thanks for the ping! |
Less wordy and more direct
but don't go into too much detail
There was a problem hiding this comment.
@ironnysh - If you check out the PR 1270 it should show you the most recent versions of the repos overview, which can be found in
/packages/docs/site/docs/01-start-here/03-repos-overview.md
Good find, made suggestions for changes but never committed them
Let me know what you think, once resolved I'll request review
|
Build is failing, more info below ## [Playground Tools]((https://github.com/WordPress/playground-tools/))(double parenthesis) Trying to get everything situated with my local copy of the PR, then the build should pass. |
I tried to balance the objective of the original issue (WordPress#1259) and this PR: - @adamziel's intention (as I understand it) is to clarify the ecosystem: > Let's write a page that explains the structure of the larger Playground initiative, especially around GitHub repositories and what are they for. - @flexseth's PR focuses on "action": > guide users to submitting issues as accurately as possible To achieve this, I did the following: 1. Reorder the repos by relevance. 2. Add an intro. 3. Revise the content to describe "what you'll find here" _and_ how to participate (contribute/get help). Finally, I removed redundant references, fixed formatting, and polished the wording.
|
@flexseth, review finished 🎉 |
| - [https://github.com/WordPress/blueprints](https://github.com/WordPress/blueprints). | ||
| - [https://github.com/WordPress/blueprints-library](https://github.com/WordPress/blueprints-library/). | ||
|
|
||
| By mapping where each part is, we hope to encourage you to get familiar with the codebase and understand how Playground is built. Visit the relevant repository to ask questions, report bugs, discover solutions to problems you run into, and share your knowledge with the community. |
There was a problem hiding this comment.
We encourage users to get familiar with the codebase and understand the Playground ecosystem. Visit the relevant repository to join discussions, report bugs, discover solutions to problems you run into, and share your knowledge with the community.
There was a problem hiding this comment.
We encourage users to get familiar with the codebase and understand the Playground ecosystem. Visit the relevant repository to join discussions, report bugs, discover solutions to problems you run into, and share your knowledge with the community.
❌ We encourage users
"we hope to encourage you..." feels like a personal invitation compared to this imperative opening.
❌ join discussions
The word "discussion" has a specific definition on GitHub, and not all repos have discussion.
What is this PR doing?
Explains the difference between the various repositories, what tools are available in which, and helps to guide users to submitting issues as accurately as possible.
What problem is it solving?
Some of the repositories were "hidden" - I didn't even find them until well into discovery! Let's improve that ASAP :)
How is the problem addressed?
An overview page that links to all of the repos, fulfills
Testing Instructions
Check it out!