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.

Sign up for GitHub

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

Jump to bottom

[BB-628] Make small corrections to EdX Docs. #1798

Merged
merged 7 commits into from
Feb 21, 2019
Merged

[BB-628] Make small corrections to EdX Docs. #1798

merged 7 commits into from
Feb 21, 2019

Conversation

giovannicimolin
Copy link
Contributor

@giovannicimolin giovannicimolin commented Feb 5, 2019 •
edited by grantgoodmanedX
Loading

This PR updates some old information on the documentation.
This covers:

  • Updating installation instructions for XBlocks on the Docker Devstack
  • Removing references of the color bar for indicating status on sections (the color bars are now only on the subsections)

Reviewers

  • @viadanna
  • Doc team review (sanity check, copy edit, or dev edit?): @edx/doc
  • EdX Reviewer TBD

Testing

  • Ran ./run_tests.sh without warnings or errors

Post-review

  • Add a comment with the description of this change or link this PR to the next release notes task.
  • Squash commits

@openedx-webhooks
Copy link

openedx-webhooks commented Feb 5, 2019 •
edited
Loading

Thanks for the pull request, @giovannicimolin! I've created OSPR-3051 to keep track of it in JIRA, where we prioritize reviews. 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:

  • 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 needs triage open-source-contribution PR author is not from Axim or 2U labels Feb 5, 2019
@natabene
Copy link

natabene commented Feb 5, 2019

@giovannicimolin Thank you for your contribution. Please let me know once it is ready to be looked at by edX reviewers.

@openedx-webhooks openedx-webhooks added waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed needs triage labels Feb 5, 2019
viadanna
viadanna suggested changes Feb 6, 2019
View reviewed changes
Copy link

@viadanna viadanna 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, just a minor change.

en_us/xblock-tutorial/source/edx_platform/devstack.rst Show resolved Hide resolved
viadanna
viadanna approved these changes Feb 8, 2019
View reviewed changes
Copy link

@viadanna viadanna left a comment

Choose a reason for hiding this comment

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

Good to go 👍

  • I tested this by checking the rendered doc.
  • I read through the code.
  • I checked for accessibility issues.
  • Includes documentation.

@giovannicimolin
Copy link
Contributor Author

@natabene This is ready for review.

@natabene
Copy link

natabene commented Feb 8, 2019

@grantgoodmanedX Can you give this a look?

@openedx-webhooks openedx-webhooks added awaiting prioritization engineering review and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. awaiting prioritization labels Feb 8, 2019
@natabene
Copy link

@grantgoodmanedX Gentle ping, asking for review.

grantgoodmanedX
grantgoodmanedX approved these changes Feb 21, 2019
View reviewed changes
Copy link
Contributor

@grantgoodmanedX grantgoodmanedX 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, thanks.

@grantgoodmanedX grantgoodmanedX merged commit 22532e2 into openedx:master Feb 21, 2019
@openedx-webhooks
Copy link

@giovannicimolin 🎉 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

@viadanna viadanna viadanna approved these changes

@grantgoodmanedX grantgoodmanedX grantgoodmanedX approved these changes

Assignees
No one assigned
Labels
merged open-source-contribution PR author is not from Axim or 2U
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@giovannicimolin @openedx-webhooks @natabene @viadanna @grantgoodmanedX