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

merging docs #797

Merged
merged 6 commits into from
Jan 22, 2025
Merged

merging docs #797

merged 6 commits into from
Jan 22, 2025

Conversation

jesgreco
Copy link
Contributor

integrate in one doc:
create_section.rst and create_section.txt into create_hide_delete_section.rst.

integrate in one doc:
create_section.rst and create_section.txt into create_hide_delete_section.rst.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 17, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @jesgreco!

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 self-requested a review January 17, 2025 16:41
Copy link
Contributor

@jswope00 jswope00 left a comment

Choose a reason for hiding this comment

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

What you are trying to do here is similar to what I did with subsections:
#795

There is some more to it. You'll need to delete the redundant files once merged into the larger file. Then you'll need to update any references that break. I.e. remove references to deleted files and use the ..START HERE ...END HERE syntax to pull the relevant info into the quickstart.

@jswope00
Copy link
Contributor

@jesgreco I think the warning messages here are fairly straightforward:

1. /home/docs/checkouts/readthedocs.org/user_builds/docsopenedxorg/checkouts/797/source/educators/navigation/creating_course.rst:58: WARNING: toctree contains reference to nonexisting document 'educators/how-tos/create_section':

You need to delete the reference to create_section in the creating_course.rst navigation file.

2. /home/docs/checkouts/readthedocs.org/user_builds/docsopenedxorg/checkouts/797/source/educators/quickstarts/build_a_course.rst:34: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'educators/how-tos/reusable_content/create_hide_delete_section.rst'.

Your include path is incorrect. There is an error in the path and then an s missing from the file name. It should be this, I think:

.. include:: ../how-tos/course_development/create_hide_delete_sections.rst

@jesgreco
Copy link
Contributor Author

Thanks @jswope00 for the explanation. I've just fixed it! :)

@jswope00 jswope00 merged commit da977bf into openedx:main Jan 22, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants