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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: cleanup #474

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

CodeWithEmad
Copy link
Contributor

@CodeWithEmad CodeWithEmad commented Mar 3, 2024

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:

  • followed the heading symbols for most of the docs (I might missed some. There was a lot!)
  • fixing the deprecation/removal of titles for quince

@openedx-webhooks
Copy link

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:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 3, 2024
@CodeWithEmad
Copy link
Contributor Author

CodeWithEmad commented Mar 3, 2024

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
Copy link
Contributor

pdpinch commented Mar 4, 2024

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

@CodeWithEmad
Copy link
Contributor Author

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

@pdpinch pdpinch self-assigned this Mar 18, 2024
@sarina
Copy link
Contributor

sarina commented Mar 25, 2024

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
Copy link
Contributor Author

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

@sarina
Copy link
Contributor

sarina commented Mar 25, 2024

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
Copy link
Contributor

pdpinch commented Mar 25, 2024 via email

@CodeWithEmad
Copy link
Contributor Author

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

@CodeWithEmad
Copy link
Contributor Author

I'll move other changes to different PRs.

@pdpinch
Copy link
Contributor

pdpinch commented Apr 15, 2024

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

@CodeWithEmad
Copy link
Contributor Author

CodeWithEmad commented Apr 15, 2024

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

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: In Eng Review
Development

Successfully merging this pull request may close these issues.

None yet

4 participants