Skip to content
This repository has been archived by the owner on May 2, 2024. It is now read-only.

Document "local sandbox" instructions for PRs somewhere #122

Closed
3 tasks
kdmccormick opened this issue Oct 6, 2022 · 2 comments
Closed
3 tasks

Document "local sandbox" instructions for PRs somewhere #122

kdmccormick opened this issue Oct 6, 2022 · 2 comments
Labels
documentation Relates to documentation improvements

Comments

@kdmccormick
Copy link
Collaborator

kdmccormick commented Oct 6, 2022

Background

There is desire, particularly around frontend developers, to spin up a cloud-hosted sandbox, running Open edX with a specific version of each service & frontend whenever a PR is made. That would allow reviewers to easily test out changes.

Until we have that, we could help PR reviewers leverage Tutor to create a "local sandbox" for any given PR. The idea is that we'd have some template of Tutor commands that a PR author could fill in. The author would include the commands in their PR description. Reviewers could run the commands on their computer in order to get a local sandbox.

Tasks

  • Come up with a set of Tutor commands that, when run:
    • configures Tutor to a run certain versions of edx-platform, the frontend in question, and any other necessary apps;
    • builds images; and
    • starts the platform.
  • Document these commands somewhere so that PR authors can include them in the PR descriptions for reviewers to use.
  • Add these commands to the frontend-template-application PR template.
@kdmccormick kdmccormick self-assigned this Oct 7, 2022
@kdmccormick
Copy link
Collaborator Author

@brian-smith-tcril just letting you know, I didn't get to this as quickly as I thought I would, but I haven't forgotten about it.

@kdmccormick kdmccormick removed their assignment Jan 27, 2023
@kdmccormick kdmccormick added documentation Relates to documentation improvements and removed 📚 docs labels May 31, 2023
@kdmccormick
Copy link
Collaborator Author

This is a still a good idea, but I'm not going to be able to work on it any time soon.

@kdmccormick kdmccormick closed this as not planned Won't fix, can't repro, duplicate, stale Mar 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Relates to documentation improvements
Projects
None yet
Development

No branches or pull requests

1 participant