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

(FC-68) Jswope00/Update Quickstart to Only use How-to snippets #840

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

jswope00
Copy link
Contributor

Update the build_a_course.rst to only use how-to snippets instead of "reusable" txt files. This eliminates redundancy and consolidates us to only using .rst files

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 19, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 19, 2025

Thanks for the pull request, @jswope00!

This repository is currently maintained by @openedx/docs-openedx-org-maintainers.

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.


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.

@jswope00 jswope00 requested a review from sarina February 19, 2025 21:16
@jswope00 jswope00 marked this pull request as ready for review February 19, 2025 21:17
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Feb 19, 2025
@sarina
Copy link
Contributor

sarina commented Feb 20, 2025

One thing I'll note is that changing all the ref names will cause the redirects in edx-documentation to fail. I can deal with this, it's just annoying.

What do you think the best way for me to review this one is, it's huge... 🙂

@jswope00
Copy link
Contributor Author

@sarina I merged main into this PR which greatly reduced the complexity of the review now.

Copy link
Contributor

@sarina sarina left a comment

Choose a reason for hiding this comment

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

John this looks good to me but I find the sidebar-within-content to be a bit cramped/squished, I posted some screenshots. What do you think?


.. sidebar:: Edit Multiple Choice Problem

.. thumbnail:: /_images/Educators_edit_multiple_choice.png
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure how I feel about using sidebars and thumbnails. There's already a righthand and lefthand sidebar on the site, so this gets really crammed in on a laptop screen

image image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I'm in favor of inline images for all images. I know that a lot of effort was put into the the original quickstart, but given the formatting changes it makes sense now to just shift the images from thumbnail to inline. I'll make the change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Full size images are in the latest commit: 7a62a66

@sarina
Copy link
Contributor

sarina commented Mar 2, 2025

@jswope00 this one still needs to be finished up, it has conflicts now.

@jswope00
Copy link
Contributor Author

jswope00 commented Mar 3, 2025

@sarina conflicts resolved, some refs updated, and images changed to full width. Ready for review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: In Eng Review
Development

Successfully merging this pull request may close these issues.

4 participants