Skip to content

docs: update the readmes and the how-tos, add quickstart and a tutorial#61

Merged
MaferMazu merged 3 commits intoopenedx:mainfrom
eduNEXT:mfmz/update-doc
Nov 15, 2023
Merged

docs: update the readmes and the how-tos, add quickstart and a tutorial#61
MaferMazu merged 3 commits intoopenedx:mainfrom
eduNEXT:mfmz/update-doc

Conversation

@MaferMazu
Copy link
Copy Markdown
Contributor

@MaferMazu MaferMazu commented Nov 10, 2023 •
edited
Loading

Description

This PR:

  • Fix the docs (The decision 4 wasn't in any index)
  • Update the Quickstart, the How-tos, and the READMEs
  • Create a Tutorial

How to test

Run an environment

  • Create a python8 venv and activate it
virtualenv -p python3.8 venv
source venv/bin/activate
  • Install requeriments
make requirements
  • Enter in docs
cd docs
  • Compile
make html
  • Run the server
cd ..
make serve_docs

(By default uses port 8000)
or

cd ..
python -m http.server 8200 --directory build/html

(If you need to serve this in another port)

Screenshots

Screenshot from 2023-11-10 12-49-03
Screenshot from 2023-11-10 12-49-45
Screenshot from 2023-11-10 12-50-37

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

openedx-webhooks commented Nov 10, 2023 •
edited
Loading

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 force-pushed the mfmz/update-doc branch 2 times, most recently from 9f2ad55 to 410822c Compare November 10, 2023 17:58
@MaferMazu MaferMazu marked this pull request as ready for review November 10, 2023 18:02
@MaferMazu
Copy link
Copy Markdown
Contributor Author

MaferMazu commented Nov 10, 2023

Hello @wlvasquez, I was wondering if you could help me review this documentation PR. Can you? I really appreciate any help you can provide.

wlvasquez
wlvasquez reviewed Nov 10, 2023
View reviewed changes
Copy link
Copy Markdown

@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 notes:

  1. Replace conjunctions, spell out (you'll for you will)
  2. Some actionable steps are in "" better that they be Bold text. Eg. Select Add New.
  3. perhaps you may want to create a short bulleted list to accelerate navigation at the beginning of the article. This way people get a quick view of what topics are covered within the article.

wlvasquez
wlvasquez reviewed Nov 10, 2023
View reviewed changes
Copy link
Copy Markdown

@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.

Left several comments to help you polish the articles

@MaferMazu
Copy link
Copy Markdown
Contributor Author

MaferMazu commented Nov 11, 2023

Thanks for your detailed feedback, @wlvasquez 🙌 I will apply your suggestions.

@MaferMazu
Copy link
Copy Markdown
Contributor Author

MaferMazu commented Nov 11, 2023

I already applied your suggestion @wlvasquez. If you want to review only my recent changes, you can visit this: e6642cb
I am attentive if you have more comments or feedback, and thanks again for reviewing this 🙌

@wlvasquez
Copy link
Copy Markdown

wlvasquez commented Nov 11, 2023 •
edited
Loading

Readme.md and readme.rat: lines 40-44 appear to be steps, but are not numbered.

I think you covered everythjng else. Glad I could help 😉

@MaferMazu
Copy link
Copy Markdown
Contributor Author

MaferMazu commented Nov 14, 2023

Done @wlvasquez :D
Thanks again for your feedback.

@felipemontoya, can you help me review this?

felipemontoya
felipemontoya approved these changes Nov 15, 2023
View reviewed changes
Copy link
Copy Markdown
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.

Great work @MaferMazu. I think this has reached a good state to be merged now.

@MaferMazu MaferMazu merged commit 49f091b into openedx:main Nov 15, 2023
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Nov 15, 2023

@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

Reviewers

@felipemontoya felipemontoya felipemontoya approved these changes

@feanil feanil Awaiting requested review from feanil

+1 more reviewer

@wlvasquez wlvasquez wlvasquez left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Contributions
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@MaferMazu @openedx-webhooks @wlvasquez @felipemontoya