Page MenuHomePhabricator

Publish the sandbox as part of Netlify deployment previews
Closed, ResolvedPublic

Description

Currently, the Netlify deployment previews of every Codex patch (e.g. https://820699--wikimedia-codex.netlify.app) only include the docs site, not the sandbox. If we allow contributors to initially demo new components in the sandbox without adding demos to the docs site, reviewers won't be able to see and test the new component implementation without downloading the patch locally. Similarly, the deployment preview for https://gerrit.wikimedia.org/r/c/design/codex/+/820178 doesn't display the changes made by that patch at all.

To address this, we should publish the sandbox as part of these deployment previews, e.g. under https://820178--wikimedia-codex.netlify.app/sandbox .

Acceptance Criteria

  • Confirm that the sandbox page is properly generated as part of the deploy preview for an open component patch in Codex.

Event Timeline

Change 821258 had a related patch set uploaded (by Catrope; author: Catrope):

[design/codex@main] build: Publish the sandbox alongside Netlify deployment previews

https://gerrit.wikimedia.org/r/821258

The sandbox is currently being cleaned up and re-organized (see T311243: Clean up the Vite sandbox – new screenshot included there). Thus far it has not been something that is available for public consumption. If we make it public, are we concerned about regular users finding it by mistake (when they are looking for the full docs) and otherwise getting confused?

If this is a concern, we could try to solve it with one of the following approaches:

  • Add a simple link somewhere in the sandbox top navigation that links to the proper docs (we'd need to ensure this stayed in sync with development and deploy preview versions – it probably shouldn't just be the hard-coded permalink to the docs page)
  • Add some text to the top that explains what the sandbox is for
  • Adopt some standards for how components within the sandbox should be documented

Out of these approaches my preference would be the first – just add a link to the docs and otherwise don't clutter up the Sandbox too much. Thoughts?

I'd also like to consider this task "blocked" until T311243: Clean up the Vite sandbox is approved and merged, so that our newly visible Sandbox page is in better shape. I'll add that as a sub-task here.

If we make it public, are we concerned about regular users finding it by mistake (when they are looking for the full docs) and otherwise getting confused?

To be clear, I'm not proposing publishing it as part of our docs site at https://doc.wikimedia.org/codex/main , but only as part of the Netlify deployment previews at https://123456-wikimedia-codex.netlify.app . Those deployment previews are hard enough to find in the first place, and already potentially confusing if someone finds them (because they'll show a version of Codex that is either futuristic or outdated). Then the sandbox would be at https://123456--wikimedia-codex.netlify.app/sandbox , which is not linked from anywhere.

That said, I'd be totally fine with adding a simple link to the sandbox to direct confused people to the actual documentation.

Change 821258 merged by jenkins-bot:

[design/codex@main] build: Publish the sandbox alongside Netlify deployment previews

https://gerrit.wikimedia.org/r/821258

To be clear, I'm not proposing publishing it as part of our docs site at https://doc.wikimedia.org/codex/main , but only as part of the Netlify deployment previews at https://123456-wikimedia-codex.netlify.app

Okay, great. Moving this to the "QTE sign off" column – we can confirm that sandbox previews are being generated properly (using the updated sandbox page from T311243: Clean up the Vite sandbox) once both this task and T311243 are merged. Then both tasks can be closed since there is nothing to release.

Once all the new infrastructure is in place, @Catrope you and I should sit down with @EUdoh-WMF to figure out a good component testing workflow, and then we can finalize the relevant docs and (hopefully) close out T306180: [Epic] Define manual testing & QA strategy in Codex .

Okay, great. Moving this to the "QTE sign off" column – we can confirm that sandbox previews are being generated properly (using the updated sandbox page from T311243: Clean up the Vite sandbox) once both this task and T311243 are merged. Then both tasks can be closed since there is nothing to release.

Based on the above, I will move this to Product Sign-Off since the outcome of this will be seen after T311243.

To be clear, I'm not proposing publishing it as part of our docs site at https://doc.wikimedia.org/codex/main , but only as part of the Netlify deployment previews at https://123456-wikimedia-codex.netlify.app

Okay, great. Moving this to the "QTE sign off" column – we can confirm that sandbox previews are being generated properly (using the updated sandbox page from T311243: Clean up the Vite sandbox) once both this task and T311243 are merged. Then both tasks can be closed since there is nothing to release.

The other task is now also merged, and you can see this task in action here: https://821321--wikimedia-codex.netlify.app/sandbox/

Once all the new infrastructure is in place, @Catrope you and I should sit down with @EUdoh-WMF to figure out a good component testing workflow, and then we can finalize the relevant docs and (hopefully) close out T306180: [Epic] Define manual testing & QA strategy in Codex .

I'll get something on the calendar for later this week.

egardner updated the task description. (Show Details)

This is now working properly on Netlify, so I think we can consider this resolved.

Change 823725 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[mediawiki/core@master] Update Codex from v0.1.0-alpha.9 to v0.1.0-alpha.10

https://gerrit.wikimedia.org/r/823725

Change 823725 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v0.1.0-alpha.9 to v0.1.0-alpha.10

https://gerrit.wikimedia.org/r/823725