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: add the first ADRs #55

Merged
merged 2 commits into from
Nov 7, 2023
Merged

docs: add the first ADRs #55

merged 2 commits into from
Nov 7, 2023

Conversation

MaferMazu
Copy link
Contributor

Description

This PR adds 3 ADRs:

  • Purpose of this Repo
  • API connection
  • Fulfillment and refund

And I slightly changed the index to clarify the supporting info.

I made those changes following the ADR template from the OEP-19: Developer Documentation.

Testing instructions

  • Principally, I want you to help me review the content of the documents I edited.
  • To see the documentation locally in the browser, you must create a python venv, install the docs.txt requirements, run make html inside the docs directory, and then run python -m http.server 8200 --directory build/html.

Additional information

Screenshot of the index view
Screenshot from 2023-10-24 21-28-45

Screenshot of the Fulfillment and refund ADR
Screenshot from 2023-10-24 21-41-56

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 25, 2023
@openedx-webhooks
Copy link

Thanks for the pull request, @MaferMazu! 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.

@MaferMazu MaferMazu requested a review from feanil October 25, 2023 03:04
@MaferMazu
Copy link
Contributor Author

@wlvasquez @julianramirez2, can you review this, please? Your insight will be helpful to be sure of the correctness and clarity of the information.

Copy link
Contributor

@julianramirez2 julianramirez2 left a comment

Choose a reason for hiding this comment

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

Looks good to me

Copy link

@wlvasquez wlvasquez left a comment

Choose a reason for hiding this comment

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

A few minor grammar and formatting recommendations were added for your consideration.

@MaferMazu
Copy link
Contributor Author

Thanks @julianramirez2
@wlvasquez, if you have more feedback, let me know :D

@MaferMazu MaferMazu merged commit f240dc0 into openedx:main Nov 7, 2023
3 checks passed
@openedx-webhooks
Copy link

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

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
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants