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

Web app redesign #1655

Open
bgrgicak opened this issue Jul 31, 2024 Discussed in #1652 · 6 comments
Open

Web app redesign #1655

bgrgicak opened this issue Jul 31, 2024 Discussed in #1652 · 6 comments
Assignees

Comments

@bgrgicak
Copy link
Collaborator

bgrgicak commented Jul 31, 2024

Discussed in #1652

Originally posted by bgrgicak July 29, 2024
Figma design

Content(2)

@WordPress/playground-maintainers Let's discuss the Web app redesign.
We have a new design that I broke it down into rough tasks and created a timeline.

Timeline

The project is broken up into smaller pieces that can be delivered individually, so we can ship things immediately and avoid feature branches. If a feature requires more PRs like the site manager, we could hide it behind a feature flag (show only in development mode or if a query string exists) until it's ready.

Phase 1: Fundamentals

Let's start by creating the fundamentals like site storage and site switching.
Alongside this, we can start replacing existing modals with new components.

Phase 2: Redesign

Let's expand the fundamentals by adding the site manager editor and support for all existing features in the current view.
After we have feature support, we can update the site header.

  • Site manager editor
    • Settings
      • Site details and header without menu
      • Edit settings
      • Header menu
        • Duplicate site
        • Reset site
        • Delete site
      • Theme preview
      • WP admin
      • Edit blueprint
    • Logs
  • Site manager preview
  • Site view header

Phase 3: Improvements

In the end, let's tackle all non-blocking work and improvements that don't exist in the current design.

  • Hide the WordPress admin bar and scroll bar from the site preview
  • Save temporary site
  • Reload temporary site modal
  • Offline features
  • Share feedback
  • E2E tests (ideally as we go)
  • Analytics

Features

A detailed list of all the features that the design includes. It will help us break down the project into tasks once we answer all questions.

Other, related issues:

Expand the full list of features

Site Storage

We need a way to store a list of all sites the user has created. Let's make it flexible so that we can add more data in the future.

  • Playground does not load in Safari with Browser storage enabled #1239
  • Site list each site in OPFS has a metadata.json file
    • Site title
    • Site slug
    • Favicon (ideally base64 encoded)
    • Blueprint
    • Date created
    • Date last active (used to determine the current site)
    • Logs
    • Storage (browser | none | device)
  • Add site with default settings
  • Update site
  • Delete site
  • Reset site
  • Get site

Site manager

The site manager consists of a sidebar, site editor, site preview, and notice sections.

Sidebar

  • Search sites
  • Site list
    • Select a current site
    • Site favicon
    • Site title
    • Temporary site indicator
  • Add site
    • WP PR preview
    • Import from GH
    • Import ZIP
  • Offline mode
    • Download all versions button
  • Links

Add site

A site can be added using a site settings modal, or by importing from different sources.

  • WP PR preview
    • PR URL or Number
    • Extra settings (uses Site settings)
  • Import from GH
    • Connect to GitHub
    • Repo select
      • Repo URL
      • Extra settings (uses Site settings)
  • Import ZIP
    • Select ZIP

Notice

  • When offline show a notice at the top.

Site preview

  • The preview can be resized by dragging a handle between the preview and the editor.
  • On extra large screen only the preview keeps expanding. The editor size is fixed.
  • Clicking on the preview will take you to the site.
  • The preview is hidden on small screens.

Site editor

Notice

  • If the current site is temporary, show a notice to save the site.

Header

  • Site favicon
  • Site title
  • Date created
  • Links
    • WP admin
      • Opens wp-admin and logs in the user.
    • Open site
  • Menu
    • Duplicate
      • Opens an edit settings modal that creates a new site after saving
    • Reset
      • Resets both settings and data
      • Confirm modal
    • Delete
      • Confirm modal
    • Export to GitHub
    • Download as .zip
    • Restore from .zip
    • Share feedback

Export to GitHub

  • Connect to GitHub
  • Export form
    • PR action type
      • Create new
      • Create draft
      • Update existing
    • PR title (for new and draft)
    • Export (select export type)
      • Theme
        • Select theme
      • Plugin
        • Select plugin
      • wp-content
      • Specific paths
        • Is there a design for this?
      • Repository URL
      • Target repository path
      • Commit message (optional)

Download as .zip

  • When clicked downloads the site zip.

Restore from .zip

  • A ZIP upload form. When uploaded the site content is replaced with the ZIP content.

Share feedback

  • A form for sharing feedback with the Playground team.

  • 1-5 score

  • How can we improve (optional)

  • Email address (optional)

Settings

  • Theme
    • Theme screenshot
    • Download theme link
    • Theme name
  • Site details
    • Site name
    • Storage type
      • Local
      • Browser
      • temporary
        • Save button
    • WordPress version
    • PHP version
    • Local path
      • For local type only
    • Network access
  • WP-admin (This might be removed)
    • Username
    • Password
    • Admin URL
  • Edit settings
  • Edit blueprint (opens the blueprint editor)

Site settings

  • Site name (can be hidden)
  • WP version
  • PHP version
  • Site language
  • Storage
  • Local path (for local storage only)
    • Path input
    • Directory picker
  • Advanced
    • Advanced section can be collapsable or always visible
    • Build version (light/kitchen sink)
    • Networking toggle
  • Delete site (when editing an existing site)

Logs

  • No logs component
  • Log search
  • Copy all logs button
  • Clear all logs button
  • Filters
    • How do filets work?
  • Log list
    • Log message
    • Copy message

Site view

  • Temporary sites show a confirmation notice if attempting to refresh
  • Header
    • Site editor link
    • Title bar

Title bar

  • View mode
    • Site name
    • Current page name from the title tag
    • Temporary site indicator
    • Keyboard shortcut indicator
  • Edit mode (when clicked)
    • Edit URL input
    • List of predefined pages
    • Edit site button (opens Site settings modal)
@bgrgicak bgrgicak self-assigned this Jul 31, 2024
bgrgicak added a commit that referenced this issue Aug 8, 2024
**Warning** This PR contains a lot of TODOs because I didn't want it to
get too large. We can decide if it's worth shipping as is or if we need
to implement some of these missing features first.

## Motivation for the change, related issues

Implements #1656

Browser storage in Playground supports having multiple sites by
switching by adding a `site-slug` query string.
This is a powerful feature that's hard to discover.

As a first step in the [Web app redesign
project,](#1655)
this PR implements switching sites in browser storage.

Other site management features like adding and deleting sites will be
added in future PRs.

![Screenshot 2024-08-01 at 12 20
55](https://github.com/user-attachments/assets/b820a040-d9a8-4eb9-aaa0-7d480385e979)
![Screenshot 2024-08-01 at 12 21
08](https://github.com/user-attachments/assets/3ace3f63-7edf-4ab5-b332-78be3ef692a9)

## Implementation details

The goal of this PR is to set the groundwork for the [Web app
redesign](#1655)
project by allowing users to switch between views.

The feature is only available while using browser storage.

The current view is now called `site-view` and the new management view
is called `site-manager`.

In this iteration, switching is done by redirecting to a URL with a
`site-manager=true` query string.
A future iteration will remove the need for reloads.

When in the site manager a list of sites is loaded from OPFS, clicking
on a site (or preview) will redirect to that site.
This is a temporary implementation that will be removed[ once we add
site
storage.](#1659)

## Testing Instructions (or ideally a Blueprint)

- Checkout this branch
- [Open Playground with browser
storage](http://127.0.0.1:5400/website-server/?storage=browser)
- Confirm that a new site manager icon is available in the upper left
corner
- Click it and confirm that the site manager loads
- [Open Playground with browser storage and a custom
slug](http://127.0.0.1:5400/website-server/?storage=browser&site-slug=test)
- Click on the site manager icon and confirm that the site manager loads
- Confirm that both sites are visible

---------

Co-authored-by: Brandon Payton <[email protected]>
bgrgicak added a commit that referenced this issue Aug 8, 2024
## Motivation for the change, related issues

The site manager button looks different in production from other buttons
and they should all look the same.

## Implementation details

Use the button component for the site manager toolbar button.

For some reason buttons a development server look different from buttons
in production.
[The toolbar will soon be
replaced](#1655),
so there is no need to fix that now.

## Testing Instructions (or ideally a Blueprint)

- Open a Playground preview locally
- Switch to site storage
- Confirm that all toolbar buttons have the same style.
@bgrgicak
Copy link
Collaborator Author

bgrgicak commented Aug 8, 2024

The sidebar is now deployed and can be used with browser storage.

Screen.Recording.2024-08-08.at.12.11.21.mov

@sfougnier
Copy link

Could we please remove the branding (logo, large graphic) from the sidebar? It's not final.

brandonpayton added a commit that referenced this issue Aug 22, 2024
## Motivation for the change, related issues

We are removing because branding is not finalized yet. Mentioned by
@sfougnier
[here](#1655 (comment)).

## Implementation details

This PR hides the logo and background graphic from the site manager
sidebar.

## Testing Instructions (or ideally a Blueprint)

Run `npm run dev`, open the site listing, and observe the UI remains
visible and functional.
@brandonpayton
Copy link
Member

@sfougnier, the branding was removed from the sidebar in #1700 and the update is deploying now.

@adamziel
Copy link
Collaborator

adamziel commented Aug 29, 2024

We'll need to introduce a routing system in v1 @bgrgicak @brandonpayton. We'll need:

  • Access to the current query args/blueprint via redux
  • A single source of truth without switching between query args, react props, redux state
  • Support for both path-based routing and access to query args
  • A single function to call when switching sites that will take care of the redux state and browser history change. This is mostly for Query API. The actual UI changes, like opening site details, may for now happen based on an internal state and without any URL changes.

Gutenberg's Navigator component doesn't seem that helpful for us. A custom redux-based routing system seems like the next best thing.

@bgrgicak
Copy link
Collaborator Author

bgrgicak commented Sep 9, 2024

A custom redux-based routing system seems like the next best thing.

This will be great for the website! We have query string fetching and props for this all over the place. Redux will make it much cleaner. It should also simplify change management and ensure component state matches the URL.

@adamziel
Copy link
Collaborator

Let's remove any custom JS API code from the "import from git" and "from WordPress/Gutenberg PRs" modals and only use them as a piece of UI that produces a Blueprint. The Blueprint itself should be expressive enough to import all the right files. This issue tracks support for the features we'll need to do that: #1787

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Project: In Progress
Development

No branches or pull requests

4 participants