Skip to content

Docs: Explain all the Playground repositories #1259

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

Open
adamziel opened this issue Apr 16, 2024 · 7 comments
Open

Docs: Explain all the Playground repositories #1259

adamziel opened this issue Apr 16, 2024 · 7 comments
Assignees
Labels
[Type] Documentation Improvements or additions to documentation [Type] Enhancement New feature or request

Comments

@adamziel
Copy link
Collaborator

Let's write a page that explains the structure of the larger Playground initiative, especially around GitHub repositories and what are they for.

Repos to cover:

Done is

Related resources

@adamziel adamziel added [Type] Documentation Improvements or additions to documentation [Type] Enhancement New feature or request labels Apr 16, 2024
@flexseth
Copy link
Collaborator

Welp, I got excited and worked on it and missed the

A Pull Request for this repository proposing a new documentation page at packages/docs/site/docs/01-start-here/04-wordpress-playground-ecosystem.md

FWIW: I've been having some issues picking up on using Git with PRs, so maybe this was my lowered barrier-of-entry way to go.

Note

There's no info on the docs-workflow repo - I'm trying to get done what I can before people get online shortly.

@flexseth
Copy link
Collaborator

@adamziel I will add the playground-docs-workflow repo and request review again

@adamziel
Copy link
Collaborator Author

adamziel commented Apr 18, 2024

@flexseth actually this is a good repo to target, let's stay here for now, I'm happy to help remove the extra files from this PR – the playground-docs-workflow needs a bit more love before it can power the documentation.

@flexseth
Copy link
Collaborator

I went in the wp-cli room twice today to try to talk to Alain about a trick to bring in Markdown files in bulk. Pretty sure I can get it working either way, but he could probably give a one-liner right off the top of his head. Anyways- think I figured out how to programmatically convert Markdown to Block Markup...

@adamziel
Copy link
Collaborator Author

Related adamziel/playground-docs-workflow#51

@flexseth
Copy link
Collaborator

Playground Repositories overview PR

Build passed, reviewed by @ironnysh 🏁

merge at your leisure, comment, etc!

@ironnysh
Copy link
Collaborator

ironnysh commented May 24, 2024

reviewed by @ironnysh

Not necessarily a blocker, but I haven't reviewed the text yet.

@flexseth, see #1270 (comment)

Update: Done now. It's quite a change, so I provided some (hopefully compelling) reasoning :-) dc8302c

ironnysh added a commit to flexseth/wordpress-playground that referenced this issue May 24, 2024
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Documentation Improvements or additions to documentation [Type] Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants