openedx / docs.openedx.org

[BETA] A new home for learning about Open edX
https://docs.openedx.org
Other
6 stars 53 forks source link

chore: cleanup #474

Closed CodeWithEmad closed 1 month ago

CodeWithEmad commented 4 months ago

I was just reading the docs and noticed a typo. went to fix that, and found another one and another one. After a couple of hours, I found myself cleaning up most of the documentation 🤣 I know reviewing might be painful, but look at the bright side, we will have much much cleaner documentation in the future.

This will introduce:

openedx-webhooks commented 4 months ago

Thanks for the pull request, @CodeWithEmad! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

CodeWithEmad commented 4 months ago

Also, the graphviz config on maintainers_home.html -> High Level Contribution Process has some issues and didn't render anything for me (maybe something is missing on my local?)

pdpinch commented 4 months ago

I'm willing to review this, but the build failed.

CodeWithEmad commented 4 months ago

Thanks @pdpinch My bad. I fixed the issue and built it on my local.

sarina commented 4 months ago

Yikes! I'm gonna let @pdpinch review this, but I'll jump in if needed.

@CodeWithEmad - for future cleanups, it'd be preferable if you could split into smaller pull requests and/or commits. It may take a long time to review this, and require some painful rebasing.

CodeWithEmad commented 4 months ago

For sure @sarina. I got a little too excited with my typo hunting. I'll make sure to tone it down next time!

sarina commented 4 months ago

Definitely don't turn it down, I love the changes! I really appreciate you making them.

Ways you can consider splitting it up would be do only a group of files at a time (ie only the release notes files, then only the course ops ones, etc), or splitting out different types of changes (ie one PR that only does trailing whitespace, another PR that is just fixing header definitions, etc).

pdpinch commented 4 months ago

Indeed, I haven't gotten very far with this yet. If you have some time to break it into smaller, section-based PRs, that would be motivating and help us get it merged faster.

CodeWithEmad commented 3 months ago

Sure, I'll try to break it into smaller commits.

CodeWithEmad commented 3 months ago

I'll move other changes to different PRs.

pdpinch commented 3 months ago

@CodeWithEmad does this PR need to be reviewed, or was it replaced by #481 and #482 ?

CodeWithEmad commented 3 months ago

Yes, it can use a review, @pdpinch. This one contains fixes for header definition and some misplaced URLs.

CodeWithEmad commented 1 month ago

I resolved the conflicts. Could someone please look this over? @feanil @pdpinch

openedx-webhooks commented 1 month ago

@CodeWithEmad 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.