Skip to content

docs: update readme for structures pruning scripts - #38932

Open
samuelallan72 wants to merge 1 commit into
openedx:masterfrom
open-craft:samuel/structures_pruning
Open

docs: update readme for structures pruning scripts#38932
samuelallan72 wants to merge 1 commit into
openedx:masterfrom
open-craft:samuel/structures_pruning

Conversation

@samuelallan72

@samuelallan72 samuelallan72 commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Description

The structures pruning script is little known, but rather useful. Update its readme with some quick information,
and a link to more detailed information on the official docs site.

Supporting information

Private-ref: https://tasks.opencraft.com/browse/BB-11072

Testing instructions

Depends-on: openedx/docs.openedx.org#1496

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 29, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @samuelallan72!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform-oncall.

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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Jul 29, 2026
@samuelallan72 samuelallan72 self-assigned this Jul 29, 2026
@samuelallan72
samuelallan72 requested a review from Kelketek July 29, 2026 02:09
@samuelallan72
samuelallan72 force-pushed the samuel/structures_pruning branch 2 times, most recently from fc446e8 to feab4a0 Compare July 29, 2026 02:15
The structures pruning script is little known, but rather useful.
Update its readme with some quick information,
and a link to more detailed information on the official docs site.

Also convert the readme to markdown, so we can use the Github alerts markdown extension: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts .

Depends-on: openedx/docs.openedx.org#1496

Private-ref: https://tasks.opencraft.com/browse/BB-11072
@samuelallan72
samuelallan72 force-pushed the samuel/structures_pruning branch from feab4a0 to d2619e7 Compare July 29, 2026 02:16
@Kelketek

Copy link
Copy Markdown
Contributor

👍 Looks good to me, @samuelallan72 !

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

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

3 participants