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.

Sign up for GitHub

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

Jump to bottom

Issue with page: build_a_course.rst #783 #798

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

Issue with page: build_a_course.rst #783 #798

wants to merge 12 commits into from
+62 −61

Conversation

Apgomeznext
Copy link
Contributor

This PR procures to fix the issue #783.

@Apgomeznext
fix issue openedx#783
df31ba6 
This PR procures to fix the issue openedx#783.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 21, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @Apgomeznext!

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.

@Apgomeznext Apgomeznext requested a review from jswope00 January 21, 2025 03:35
@Apgomeznext Apgomeznext mentioned this pull request Jan 21, 2025
Open
@Apgomeznext Apgomeznext requested a review from sarina January 21, 2025 03:58
sarina
sarina reviewed Jan 21, 2025
View reviewed changes
source/educators/how-tos/reusable_content/create_course.txt Outdated
/home/docs/checkouts/readthedocs.org/user_builds/docsopenedxorg/checkouts/798/source/educators/how-tos/add_units.rst:8: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'educators/how-tos/reusable_content/create_unit.txt'.
/home/docs/checkouts/readthedocs.org/user_builds/docsopenedxorg/checkouts/798/source/educators/quickstarts/build_a_course.rst:45: CRITICAL: Problem with "start-after" option of "include" directive:
Text not found.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this text in this file? I think this file can just be deleted?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Solved :)

sarina
sarina approved these changes Jan 21, 2025
View reviewed changes
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.

This looks good to me. I'd like @jswope00 to review as well since it's addressing an issue he made, and I want to be sure it's being addressed the way he intended.

jswope00
jswope00 requested changes Jan 22, 2025
View reviewed changes
source/educators/how-tos/add_units.rst Outdated

:ref:`Create a Unit` (how-to)

:ref:`Create a Subsection` (how-to)
Copy link
Contributor

Choose a reason for hiding this comment

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

@Apgomeznext This leads to a strange scenario where add_units is a clip of a larger file, and its seealso refers to itself as part of the larger file.

To me, that is difficult to follow and to understand for any new person looking at docs. And I'm not sure why it is necessary overall. I'd propose deleting add_units.rst entirely.

@jswope00
Copy link
Contributor

@Apgomeznext See my comment about line breaks between links. Also there is a conflict, likely related to the fact that Sarina has been doing work on these See Also lists as well.

@Apgomeznext
Copy link
Contributor Author

@jswope00, please let me know if there is another issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jswope00 jswope00 jswope00 requested changes

@sarina sarina sarina approved these changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: In Eng Review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Apgomeznext @openedx-webhooks @jswope00 @sarina