Skip to content

Conversation

@pomegranited
Copy link
Contributor

@pomegranited pomegranited commented Nov 7, 2024

Description

#32741 removed the documentation build step because it was taking > 40 minutes to run.

This PR adds a "documentation lint" step to the CI which uses sphinx-lint. This doesn't build the whole documentation tree, but should let PR creators know if they've made any code changes that break documentation.

This change affects Developers only.

Supporting information

See #35766 (comment) for more context.

Testing instructions

  1. Ensure the "Documentation linter" step added to the CI build is passing.

To verify that this added step helps us:

  1. Revert the change made by fix: adds content.search to docs apps #35766
  2. In a python3.11 virtualenv, run:
    pip install setuptools
    pip install -r requirements/edx/doc.txt
    
  3. make docs-lint should fail with the error reported in the referenced PR.

Deadline

None

@openedx-webhooks
Copy link

openedx-webhooks commented Nov 7, 2024

Thanks for the pull request, @pomegranited!

What's next?

Please work through the following steps to get your changes 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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 7, 2024
@pomegranited pomegranited marked this pull request as draft November 7, 2024 06:29
@pomegranited
Copy link
Contributor Author

Closing this PR as my CC time for this year has run out, and Sumac docs are building again :)

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.

2 participants