docs: add local plugin dev to README #256
Conversation
This adds documentation for how users can develop with blockstore locally in devstack.
| #. In your devstack directory, run the following commands in order: | ||
|
|
||
| .. code:: | ||
|
|
There was a problem hiding this comment.
Is there an assumption about virtual environments here? If using a virtual environment, should be activating it before these operations.
There was a problem hiding this comment.
You actually totally could do this without a venv. I know this because I accidentally did. I wouldn't recommend it though...
There was a problem hiding this comment.
This is such a base assumption for working in openedx I don't feel like I need to include it.
|
|
||
| You're probably also going to want to create a collection for using content libraries, using: | ||
|
|
||
| .. code:: |
There was a problem hiding this comment.
What are your assumptions about the existence and state of a blockstore container prior to this point? What about now?
There was a problem hiding this comment.
This guide makes no assumptions that you ever ran blockstore as a separate service, and hence, assumes no container exists. There previously was an error which referenced such a container, but that was a copy-paste error.
| The Library Authoring MFE will want to know about that collection id `using a ENV variable. <https://github.com/openedx/frontend-app-library-authoring/blob/d590aa2eb54c94b39d94f2ba12a6b458082c2e5e/.env#L19>`_ | ||
|
|
||
| Then restart Studio and the LMS (``make dev.restart-devserver.lms dev.restart-devserver.studio``). | ||
|
|
There was a problem hiding this comment.
The testing part of the readme is still a bit thin. What steps to follow and what to look for to confirm that a) the IDA is no longer running; b) the Django app is; and c) the Django app blockstore is running as expected.
There was a problem hiding this comment.
This guide doesn't care that you ever ran blockstore as a separate service. You could be running the blockstore service at the same time, but the waffle flag makes it such that it doesn't matter. This guide replaces blockstore as a service setup for local dev.
I added a part to direct the user to set up content libraries v2. That is how blockstore is used and the system's effectiveness can be tested.
|
There's a lint commit error that needs attention |
I'll just squash when I merge. |
connorhaugh
deleted the
docs-add-documentation-for-installing-local-plugin
branch
This adds documentation for how users can develop with blockstore locally in devstack as a python plugin.