-
Notifications
You must be signed in to change notification settings - Fork 269
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
WebApp Redesign #1561
Comments
Offline Playground support: Some PHP and WP versions might not be available when offline if they have 't been downloaded yet. We might need to somehow communicate that in the ux redesign, even if not in v1. |
👋 I put together the first design draft for the new web app. It accounts for all the new functionality and reshapes WP Playground to work more like a site hub, aligning closely with the new wp-admin. Most notable changesNew PG toolbar on the front-endI redesigned the top bar on the front-end to include a button for the new site management view. I also cleaned it up, removed some settings, and compressed all site-related options into a command bar-like UI at the top. There's no URL bar anymore because it can be accessed through the browser's regular UI. pg_topbar.movSite management viewUsers can jump to a new site overview screen by clicking a button in the new top bar. There, they'll be able to view all their sites (temporary, saved in the browser, and local) as well as perform actions, like adding or importing sites, previewing PRs, deleting sites, duplicating sites, and editing individual settings, e.g., WP/PHP version, features, etc. New layoutThe admin view borrows design cues from the upcoming WordPress admin redesign. It consists of three panels: a sidebar with a list of active Playground sites, a details area with an overview of site information and settings, and a preview frame. Users can resize the panels to accommodate their needs (handy if they want the preview frame to be larger or smaller). Temporary site saving flowTemporary sites are Playground instances that will disappear when users close the browser tab (storage type = none). They're highlighted in the new UI to make users aware of their unique behavior and wary of possible data loss. Contextual icons, tooltips, and notices make it easy to save a temporary site in the browser (or locally) and vice versa. Other flows, including offline mode and site management actions, are described in Figma. Feel free to take a look and share your thoughts! |
Surfacing the design for turning on the offline mode: This is the right direction, and I’d simplify this even further. We could only have two options there:
I wouldn’t offer the option to download things granularly at all. It might be useful to some, but my educated guess is most people either want full offline support or they don’t. |
Aha, and the „libxml” etc checkbox can be removed as well. Let’s just ship the full-featured build. |
Thanks, @adamziel. Could something like this work? When online, we'd show an icon and let the user know the components (name WIP) will be downloaded automatically, but we also show a button that allows them to save everything at once. When they go offline, we'll let them know that PG can only use downloaded assets. |
Meanwhile, I put together a simple prototype to show how the user would transition from the PG site preview to the new app and vice versa. Let me know what you think. pg_sitemanagement_ux.mov |
@jarekmorawski Thank you! This is exciting. Here are some things that came up for me. @jarekmorawski let me know if you would like to schedule some time to chat about these. Design feedbackFirst loadPlayground is one-click WordPress, but this UI adds more clicks on the first load. Let's adjust the flow so the user gets a temporary site first without any clicks and can store it later. Temporary sitesWhat's the goal of saving temporary sites? For regular users, this would quickly result in a lot of sites in the sidebar or would require them to maintain the list. This makes me wonder if the new settings UI is a blueprint builder. I see value in storing a temporary site blueprint in Playground and loading it with one click, but only if the user decides to save the temporary site blueprint, not by default. We had multiple attempts at building one, but having it here makes sense. If we combine the ability to store blueprints with showing demos in Playground we have a blueprint gallery. Header expand/collapseI would skip the header expand/collapse feature. The seamless mode is intended for integration where someone wants to embed Playground as-is and allowing users to customize Playground would break that. Also, it would create an easy way for users to download the site content which we want to avoid in case of premium plugin demos. Changing URLsThe current website UI has an address bar that allows us to go to different pages by updating the URL. For example, if I'm not logged in I would change the URL to Because the Playground website is basically a browser inside a browser, we need to communicate to users where they can update the URL and make it easy. Logs tabI like the positioning of the logs tab. It's missing the ability to search logs like we have today. With the current data structure, it will be hard to implement the suggested UI because logs are stored as strings. To get info like date, we would need to parse these strings or change how we store data. Other comments
|
Thanks for the feedback, @bgrgicak. 🙏 I'll gladly make the adjustments.
The redesign aims to default users to saved sites, which means that temporary sites created with 1-click are still possible, but are no longer a priority. Changing that will have a bigger impact on the flow, which aims to make it easy for users to create and manage saved sites.
We'd explore that. Having them in the sidebar makes it easy to find and save temporary sites they care about. Now that we default to saved, temporary sites will be outliers, so they're highlighted in the UI with the clock icon, while other site types are not.
That makes sense. I found the blueprint editor slightly confusing because it offers a different way to edit site settings, like WP version. However, I do see how it can give more power users more flexibility to add custom steps, load external plugins, etc. Perhaps we'd tweak the flow to make the site settings the primary blueprint editing experience while still letting users access the JSON if needed.
In my opinion, that should be a separate area in the app. I suspect users will not care about demos until they seek inspiration. In the future, we'd add a higher-level nav item and split the app in two:
Sounds good. I wasn't sure about that interaction anyway. 👌 Figma updated.
I see your point. Could this work? cc @adamziel pg_top_bar.mp4
I didn't know it was possible. I'll add that to my to-do list.
I suspected that, but I think it can be a worthwhile effort, especially given our plans to turn Playground into a small-scale IDE. Parsing logs and code could come in handy for editing individual lines of code... maybe even inline, while viewing the page in Playground.
I considered that but decided to only use icons to highlight temporary sites. If we show icons for each site type, the UI will get noisy. It's similar to how some apps display notification badges for urgent alerts. If they displayed them for all notifications, nothing would be important anymore.
We already have one. It should be more visible in Figma now. 👍
💯 It'd be also handy to let users edit the credentials from within the app, much like the site name and other settings. Could come in handy for dev handoff. |
I understand, but we should keep a way of auto-starting temporary sites. For example by passing a query string Another idea is to modify the initial screen. The screen could be a popup that overlays a temporary Playground site. I'm probably overcomplicating here, but my point is that we should keep the Playground is one-click WordPress concept around in some way.
Sounds good.
Nice, I like the URL input demo.
I agree. JS logs should be easy, and we can find a way to parse PHP logs. |
I'd keep that behavior and let people specify when embedding a site. We'd also create a quick link, like From inside the admin, I'd experiment with defaulting people to saved sites because 1) it's just better UX since they don't have to worry about their setups 2) this may be the expected behavior given they're already in the admin 3) deleting a site is fast and easy.
That's two clicks, isn't it? ;) I'd prefer to avoid modal and design a better path in instead. I think it all comes down to what @adamziel thinks and knows about Playground and how most people use it. He and I talked about defaulting to saved, but perhaps I missed a beat.
Sounds good. I removed the custom styling from the design for now. We can revisit once we're reading to add the IDE. |
Yes! That's lovely ❤️ I'd just somehow tell the user they don't have all the files downloaded even if they don't hover/click the cloud icon, otherwise that's brilliant.
Really nice transitions 🎉 Here's two things that came up for me:
@bgrgicak holy cow, you're right! And we could display that directly in Playground or embed it on w.org. Really nice. And with a more advanced git integration, you could contribute them directly from Playground.
@bgrgicak I've heard a few people asking for the ability to transition between the fullscreen mode and the mode with settings. It does seem useful. More thoughts coming later. |
I assume we can detect they're offline? Maybe we'd display a highly visible banner at the top of the page.
Here's the updated design. It completely overhauls the top bar so we'd no longer need the show/hide button.
If it was just a handful of people, we'd add a keyboard shortcut. 🤔 The |
I meant a scenario when they're online and unaware they don't have all the PHP versions etc available locally yet. |
This could be a good stopgap solution. Eventually, I'd like to default to a UI-based Blueprints editor and have the JSON editor as a secondary fallback / a place to paste the Blueprint into.
This seems similar to a "start new post with a template / pattern" flow, I wonder what learnings can we draw from that. Blueprints are just patterns for entire sites.
Definitely interesting! I'd make it clearer this button doubles as an address bar before the first time it's used. On the video you can see it says
+1
❤️
For the UI purposes let's assume that works as intended and use the UI as a forcing function to fix it. |
Please no 😅 there's already too many popups on the internet. Let's default to a saved Playground site as @jarekmorawski said. The only question to me is – what should happen the next time I go to playground.wordpress.net? It could be either:
I think either option works provided it's supported by the rest of the experience. For example, if we open the most recent saved site, we should make a "create new site" button apparent. If we default to creating a new saved site, we shouldn't actually add it to the list of my sites until I make a change – otherwise the list will get cluttered. I'm fine with either option.
It's not a small part of the conversations I've had. I'd make an educated guess this interaction is useful and iterate based on what we hear back. |
@jarekmorawski Is this a screenshot of the most recent version of the homepage? Could this be an arrow, like in a select box instead? |
I totally missed the point that we are now starting with stored sites and not temporary sites. In that case, it makes sense to add extra steps because you are creating something that will stay. I would prefer to see the last saved site I worked on, or if there are multiple sites already, show the Your sites sidebar to make it clear to the user that they have multiple sites already and can choose. |
We started a discussion about implementing the new design. #1652 |
Thank you – I left a few tactical comments. Overall it looks amazing – thank you so much @jarekmorawski, it's such a great work. |
I was just coming here to say the same thing. Thank you very much! |
❤️ I think it is thorough and well-considered overall. |
I left one comment about possibly keeping temporary sites in browser storage for a short time. |
We have a new issue for tracking project development. I'm closing this one because the design is completed. Thank you @jarekmorawski! |
I'll reopen and add it to the "Projects" section of the project board to have a high level overview of the ongoing work. @bgrgicak I assume we'll also need either a milestone or a project board property? |
Ah, #1655 is playing that higher level role. Alright, let's close this one. |
… WebApp Redesign (#1731) ## Description Implements a large part of the [website redesign](#1561): ![CleanShot 2024-09-14 at 10 24 57@2x](https://github.com/user-attachments/assets/f245c7ac-cb8c-4e5a-b90a-b4aeff802e7b) High-level changes shipped in this PR: * Multiple Playgrounds. Every temporary Playground can be saved either in the browser storage (OPFS) or in a local directory (Chrome desktop only for now). * New Playground settings options: Name name, language, multisite * URL as the source of truth for the application state * State management via Redux This work is a convergence of 18+ months of effort and discussions. The new UI opens relieves the users from juggling ephemeral Playgrounds and losing their work. It opens up space for long-lived site configurations and additional integrations. We could bring over all the [PR previewers and demos](https://playground.wordpress.net/demos/) right into the Playground app. Here's just a few features unblocked by this PR: * #1438 – no more losing your work by accident 🎉 * #797 – with multiple sites we can progressively build features we'll eventually propose for WordPress core: * A Playground export and import feature, pioneering the standard export format for WordPress sites. * A "Clone this Playground" feature, pioneering the [Site Transfer Protocol](https://core.trac.wordpress.org/ticket/60375). * A "Sync two Playgrounds" feature, pioneering the Site Sync Protocol * #1445 – better git support is in top 5 most highly requested features. With multiple Playgrounds, we can save your work and get rid of the "save your work before connecting GitHub or you'll lose it" and cumbersome "repo setup" forms on every interaction. Instead, we can make git operations like Pull, Commit, etc. very easy and even enable auto-syncing with a git repository. * #1025 – as we bring in more PHP plumbing into this repository, we'll replace the TypeScript parts with PHP parts to create a WordPress core-first Blueprints engine * #1056 – Site transfer protocol will unlocks seamlessly passing Playgrounds between the browser and a local development environment * #1558 – we'll integrate [the Blueprints directory] and offer single-click Playground setups, e.g. an Ecommerce store or a Slide deck editor. #718. * #539 – the recorded Blueprints would be directly editable in Playground and perhaps saved as a new Playground template * #696 – the new interaction model creates space for additional integrations. * #707 – you could create a "GitHub–synchronized" Playground * #760 – we can bootstrap one inside Playground using a Blueprint and benefit the users immediately, and then gradually work towards enabling it on WordPress.org * #768 – the new UI has space for a "new in Playground" section, similar to what Chrome Devtools do * #629 * #32 * #104 * #497 * #562 * #580 ### Remaining work - [ ] Write a release note for https://make.wordpress.org/playground/ - [x] Make sure GitHub integration is working. Looks like OAuth connection leads to 404. - [x] Fix temp site "Edit Settings" functionality to actually edit settings (forking a temp site can come in a follow-up PR) - [x] Fix style issue with overlapping site name label with narrow site info views - [x] Fix style issue with bottom "Open Site" and "WP Admin" buttons missing for mobile viewports - [x] Make sure there is a path for existing OPFS sites to continue to load - [x] Adjust E2E tests. - [x] Reflect OPFS write error in UI when saving temp site fails - [x] Find a path forward for [try-wordpress](https://github.com/WordPress/try-wordpress) to continue working after this PR - [x] Figure out why does the browser get so choppy during OPFS save. It looks as if there was a lot of synchronous work going on. Shouldn't all the effort be done by a worker a non-blocking way? - [x] Test with Safari and Firefox. Might require a local production setup as FF won't work with the Playground dev server. - [x] Fix Safari error: `Unhandled Promise Rejection: UnknownError: Invalid platform file handle` when saving a temporary Playground to OPFS. - [x] Fix to allow deleting site that fails to boot. This is possible when saving a temp site fails partway through. - [x] Fix this crash: ```ts /** * @todo: Fix OPFS site storage write timeout that happens alongside 2000 * "Cannot read properties of undefined (reading 'apply')" errors here: * I suspect the postMessage call we do to the safari worker causes it to * respond with another message and these unexpected exchange throws off * Comlink. We should make Comlink ignore those. */ // redirectTo(PlaygroundRoute.site(selectSiteBySlug(state, siteSlug))); ``` - [x] Test different scenarios manually, in particular those involving Blueprints passed via hash - [x] Ensure we have all the aria, `name=""` etc. accessibility attributes we need, see AXE tools for Chrome. - [x] Update developer documentation on the `storage` query arg (it's removed in this PR) - [x] Go through all the `TODOs` added in this PR and decide whether to solve or punt them - [x] Handle errors like "site not found in OPFS", "files missing from a local directory" - [x] Disable any `Local Filesystem` UI in browsers that don't support them. Don't just hide them, though. Provide a help text to explain why are they disabled. - [x] Reduce the naming confusion, e.g. `updateSite` in redux-store.ts vs `updateSite` in `site-storage.ts`. What would an unambiguous code pattern look like? - [x] Find a reliable and intuitive way of updating these deeply nested redux state properties. Right now we do an ad-hoc recursive merge that's slightly different for sites and clients. Which patterns used in other apps would make it intuitive? - [x] Have a single entrypoint for each logical action such as "Create a new site", "Update site", "Select site" etc. that will take care of updating the redux store, updating OPFS, and updating the URL. My ideal scenario is calling something like `updateSite(slug, newConfig)` in a React Component and being done without thinking "ughh I still need to update OPFS" or "I also have to adjust that .json file over there" - [x] Fix all the tiny design imperfections, e.g. cut-off labels in the site settings form. ### Follow up work - [ ] Mark all the related blocked issues as unblocked on the project board, e.g. #1703, #1731, and more – [see the All Tasks view](https://github.com/orgs/WordPress/projects/180/views/2?query=sort%3Aupdated-desc+is%3Aopen&filterQuery=status%3A%22Up+next%22%2C%22In+progress%22%2C%22Needs+review%22%2C%22Reviewed%22%2C%22Done%22%2CBlocked) - [ ] Update WordPress/Learn#1583 with info that the redesign is now in and we're good to record a video tutorial. - [ ] #1746 - [ ] Write a note in [What's new for developers? (October 2024)](WordPress/developer-blog-content#309) - [ ] Document the new site saving flow in `packages/docs/site/docs/main/about/build.md` cc @juanmaguitar - [ ] Update all the screenshots in the documentation cc @juanmaguitar - [ ] When the site fails to load via `.list()`, still return that site's info but make note of the error. Not showing that site on a list could greatly confuse the user ("Hey, where did my site go?"). Let's be explicit about problems. - [ ] Introduce notifications system to provide feedback about outcomes of various user actions. - [ ] Add non-minified WordPress versions to the "New site" modal. - [ ] Fix `console.js:288 TypeError: Cannot read properties of undefined (reading 'apply') at comlink.ts:314:51 at Array.reduce (<anonymous>) at callback (comlink.ts:314:29)` – it seems to happen at trunk, too. - [ ] Attribute log messages to the site that triggered them. - [ ] Take note of any interactions that we find frustrating or confusing. We can perhaps adjust them in a follow-up PR, but let's make sure we notice and document them here. - [ ] Solidify the functional tooling for transforming between `URL`, `runtimeConfiguration`, `Blueprint`, and `site settings form state` for both OPFS sites and in-memory sites. Let's see if we can make it reusable in Playground CLI. - [ ] Speed up OPFS interactions, saving a site can take quite a while. - [ ] A mobile-friendly modal architecture that doesn't stack modals, allows dismissing, and understands some modals (e.g. fatal error report) might have priority over other modals (e.g. connect to GitHub). Discuss whether modals should be declared at the top level, like here, or contextual to where the "Show modal" button is rendered. - [ ] Discuss the need to support strong, masked passwords over a simple password that's just `"password"`. - [ ] Duplicate site feature implemented as "Export site + import site" with the new core-first PHP tools from adamziel/wxr-normalize#1 and https://github.com/adamziel/site-transfer-protocol - [x] Retain temporary sites between site changes. Don't just trash their iframe and state when the user switches to another site. Closes #1719 cc @brandonpayton --------- Co-authored-by: Brandon Payton <brandon@happycode.net> Co-authored-by: Bero <berislav.grgicak@gmail.com> Co-authored-by: Bart Kalisz <bartlomiej.kalisz@gmail.com>
Now that Playground supports multiple offline sites, we need a UI redesign to actually enable using it. The redesign will also unlock:
Done is
@jarekmorawski is exploring it.
The text was updated successfully, but these errors were encountered: