docs: update readme for structures pruning scripts - #38932
Conversation
|
Thanks for the pull request, @samuelallan72! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
fc446e8 to
feab4a0
Compare
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
feab4a0 to
d2619e7
Compare
|
👍 Looks good to me, @samuelallan72 ! |
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