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

[Docs] Add Playground Manager and Save button screenshots to Developes > Limitations > Temporary by design #2145

Merged
merged 5 commits into from
Feb 27, 2025

Conversation

jswhisperer
Copy link
Contributor

@jswhisperer jswhisperer commented Feb 11, 2025

Motivation for the change, related issues

It's not obvious how to save a temporary site from reading the documentation as observed in #2133.

Implementation details

This PR adds Playground Manager and Save button screenshots to Developes > Limitations > Temporary by design documentation section.

Testing Instructions (or ideally a Blueprint)

adds details to location of save buttons to docs
Comment on lines 21 to 31
<details>
<summary>Click for a screenshot</summary>
<div>
<img width="406" alt="Open Site Manager" src="https://github.com/user-attachments/assets/f66e4116-069c-4764-9305-3cec03eb72d5" />
</div>
<br>
<div>
<img width="408" alt="Save Button" src="https://github.com/user-attachments/assets/a677fbff-2346-4579-9543-56e33e8e42b9" />

</div>
</details>
Copy link
Collaborator

Choose a reason for hiding this comment

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

We use Docusaurus to build our documentation and unfortunately, this approach breaks the build.

Here is an example of how you can add images to the documentation.

Why did you decide to collapse the image?
It would be easier to discover the save feature if the image was always visible.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Aw I'm familiar with docusaurus, sorry my markdown is rusty will adjust.
Happy to leave it expanded I just didn't want to disrupt the current docs :P

@bgrgicak
Copy link
Collaborator

Thank you for taking the time to contribute @jswhisperer!

I left some comments and tips on how to make this PR work.

Also could you please update the PR title and description to match the format and include relevant information?
The title could be something like [Docs] Add instructions on how to save sites on the Playground Website.

@jswhisperer
Copy link
Contributor Author

I will action your helpful suggestions before the weekend thanks for taking the time to review!

Gregory JSWhisperer and others added 2 commits February 25, 2025 20:06
updates the image tags to not be nested anymore but always visible.
Also corrects the markdown to compile with docusaurus
@jswhisperer
Copy link
Contributor Author

Sorry for the delayed PR update 😿
I've been hard at work interviewing.

Hopefully, this is much better and doesn't seem to break the build.
I've nested in a blockquote for a visual separation but I'm open to feedback.

@jswhisperer jswhisperer requested a review from bgrgicak February 25, 2025 20:18
@jswhisperer jswhisperer changed the title feat: issue 2133 added details feat: (2133) add images to show Site manager and Save buttons Feb 25, 2025
@bgrgicak bgrgicak changed the title feat: (2133) add images to show Site manager and Save buttons [Docs] Add Site manager and Save button screenshots to Developes > Limitations > Temporary by design Feb 27, 2025
@bgrgicak bgrgicak changed the title [Docs] Add Site manager and Save button screenshots to Developes > Limitations > Temporary by design [Docs] Add Playground Manager and Save button screenshots to Developes > Limitations > Temporary by design Feb 27, 2025
@bgrgicak
Copy link
Collaborator

Thank you for making the changes @jswhisperer!

I hope that you don't mind, but I changed the PR title and description, so it includes all relevant info and matches our other PRs.

I also renamed Site Manager to Playground Manager,because that's how we named the feature in our announcement.

@bgrgicak
Copy link
Collaborator

Sorry for the delayed PR update 😿
I've been hard at work interviewing.

Good luck with interviewing, I hope you'll find something nice soon!

@adamziel adamziel merged commit f0c983b into WordPress:trunk Feb 27, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants