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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: use new standard Open edX for documentation #63

Merged
merged 3 commits into from
Feb 7, 2023

Conversation

mariajgrimaldi
Copy link
Member

Description:
This PR generates the new files structure for docs proposed in this how-to by the community members. This is how it looks rendered with a few modifications:
image

ISSUE:
#41

Dependencies:
None

Merge deadline:
ASAP

Installation instructions:
Just documentation

Testing instructions:
Just documentation

Reviewers:

Merge checklist:

  • All reviewers approved
  • CI build is green
  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Commits are squashed

Post merge:

  • Create a tag
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)

Author concerns:
None for now

@openedx-webhooks openedx-webhooks added core committer open-source-contribution PR author is not from Axim or 2U labels Jan 26, 2023
@openedx-webhooks
Copy link

Thanks for the pull request, @mariajgrimaldi!

As a core committer in this repo, you can merge this once the pull request is approved per the core committer reviewer requirements and according to the agreement with your edX Champion.

Copy link
Member

@felipemontoya felipemontoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changes seem full reasonable to me. They affect the build format and not the content

@mphilbrick211
Copy link

Hi @mariajgrimaldi - just checking to see if this is ready to merge?

@mphilbrick211 mphilbrick211 added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Feb 7, 2023
@mphilbrick211 mphilbrick211 removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Feb 7, 2023
@mariajgrimaldi mariajgrimaldi merged commit b6e0d02 into main Feb 7, 2023
@mariajgrimaldi mariajgrimaldi deleted the MJG/update-docs branch February 7, 2023 22:25
@openedx-webhooks
Copy link

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

@pomegranited
Copy link

Hi @mariajgrimaldi ! Where can I see the newly rendered docs for this repo since this change was made? The readthedocs link on the README doesn't work anymore :(

@mariajgrimaldi
Copy link
Member Author

mariajgrimaldi commented Jun 6, 2023

Hi @pomegranited! We still need to deploy the new docs, I still need to finish writing them. But that's my priority! For the time being, you can reference this PR: #64

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core committer 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.

5 participants