Skip to content
This repository has been archived by the owner on May 14, 2024. It is now read-only.

Update README to be more helpful #76

Merged
merged 2 commits into from
Sep 14, 2020

Conversation

bradenmacdonald
Copy link
Contributor

Description

The README is missing a lot of useful information about how to use Blockstore today. This PR brings it up to date.

@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald! I've created OSPR-4892 to keep track of it in JIRA.

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.

@bradenmacdonald
Copy link
Contributor Author

@arbrandes FYI, I'm fixing the blockstore README. This should let you in turn simplify the setup/testing instructions in PRs like openedx-unsupported/frontend-app-library-authoring#4 .

BTW I notice that the frontend-app-library-authoring README is similarly in need of some love. I'm not sure if I'll get to it soon, but if you're writing up instructions for your PRs anyways you might as well put them into that README instead :)

@arbrandes
Copy link

@bradenmacdonald, this is great, thanks!

And yes, the MFE README needs a lot of love. I'll handle it when I issue my next PR. 👍

@openedx-webhooks openedx-webhooks added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Aug 17, 2020
@natabene
Copy link

@bradenmacdonald Thank you for the contribution. Do you need edX' help with reviewing or merging this?

@symbolist
Copy link
Contributor

@natabene I will be able to review this. 🙂

@bradenmacdonald
Copy link
Contributor Author

@symbolist Would you be able to review this this sprint?

@openedx-webhooks openedx-webhooks added open edx community review and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Sep 4, 2020
Copy link
Contributor

@symbolist symbolist left a comment

Choose a reason for hiding this comment

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

  • I tested the instructions for setting up the devstack.
  • I ran the integration tests.
  • I checked that the production config sample matches what we are using on one of the CI servers.

@bradenmacdonald bradenmacdonald merged commit b5c4161 into openedx-unsupported:master Sep 14, 2020
@openedx-webhooks
Copy link

@bradenmacdonald 🎉 Your pull request was merged!

Please take a moment to answer a two question survey so we can improve your experience in the future.

@openedx-webhooks
Copy link

@ormsbee, @kdmccormick: thought you might like to know that bradenmacdonald merged this pull request.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants