Skip to content

feat: easy alternative views#507

Open
Kelketek wants to merge 1 commit into
openedx:masterfrom
open-craft:fox/studio-views
Open

feat: easy alternative views#507
Kelketek wants to merge 1 commit into
openedx:masterfrom
open-craft:fox/studio-views

Conversation

@Kelketek
Copy link
Copy Markdown

Description

This PR makes it easier to test the studio and authoring views from within the workbench. This is already supported, but currently requires you to manually specify the scenario URL. This desire to avoid picking specific views made sense in the context of XBlock's original vision which might not expect there to necessarily be a studio as part of the spec. In practice, the Open edX platform is the only implementation, and is expected to stay that way, so adding some opinionated conveniences helps here.

This also includes a 'notify' function shim for the runtime. Both the LMS and studio have this notify function. We implement it here as logging.

Testing instructions

  1. Set up the workbench
  2. Install a block you'd like to test
  3. Visit the block's scenario
  4. Verify you can also load the studio scenario, and the authoring scenario, if present
  5. Save, and refresh to verify the state has changed

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels May 26, 2026
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @Kelketek!

This repository is currently maintained by @openedx/axim-engineering.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Copy link
Copy Markdown

@samuelallan72 samuelallan72 left a comment

Choose a reason for hiding this comment

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

@Kelketek 👍

  • I tested this: followed test instructions
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

@Kelketek
Copy link
Copy Markdown
Author

@farhan Would you be up for reviewing this?

@farhan
Copy link
Copy Markdown
Contributor

farhan commented May 26, 2026

@farhan Would you be up for reviewing this?

Changes LGTM, adding some test cases would be great

@Kelketek Kelketek force-pushed the fox/studio-views branch from 54e5a4a to cbb33ce Compare May 27, 2026 04:21
@Kelketek
Copy link
Copy Markdown
Author

@farhan Added a test for this.

@farhan
Copy link
Copy Markdown
Contributor

farhan commented May 27, 2026

@Kelketek
Do you access to merge it or do you want me to merge it?

@Kelketek
Copy link
Copy Markdown
Author

@farhan I don't have merge rights on this repository. Please merge it if it looks good to you. :)

@farhan
Copy link
Copy Markdown
Contributor

farhan commented May 27, 2026

@Kelketek alright, let me give it a test run on monday, as I am on leaves, after that I will share results or merge it.
Thanks for the contribution!

@farhan farhan moved this to 👀 In review in Aximprovements Team May 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: 👀 In review
Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

4 participants