-
Notifications
You must be signed in to change notification settings - Fork 25
Reorganize docs by app #579
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
Changes from all commits
3d7d78d
91a0c1e
2974f7c
64a30f0
2bab218
c72ced9
4e81039
2cc4133
e74a2f5
71ca471
9859e96
1bccf0c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| .. _openedx-content-api-reference: | ||
|
|
||
| API Reference | ||
| ============= | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,6 @@ | ||
| 20. Merge authoring apps into openedx_content (using Applets) | ||
| .. _openedx-content-adr-0010: | ||
|
|
||
| 10. Merge authoring apps into openedx_content (using Applets) | ||
| ============================================================= | ||
|
|
||
| Context | ||
|
|
@@ -50,7 +52,7 @@ We are going to take advantage of the fact that these two can be separated using | |
|
|
||
| There are a few high level constraints that we have to consider: | ||
|
|
||
| #. Existing openedx-platform migrations should not be modified. Existing openedx-platform migrations should remain unchanged. This is important to make sure that we do not introduce ordering inconsistencies for sites that have already run migrations for the old apps and are upgrading to a new release (e.g. Verawood). | ||
| #. Existing openedx-platform migrations should not be modified. This is important to make sure that we do not introduce ordering inconsistencies for sites that have already run migrations for the old apps and are upgrading to a new release (e.g. Verawood). | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This was a typo that just irritated me too much to not fix when I ran across it. |
||
| #. The openedx-learning repo should not have any dependencies on openedx-platform migrations, because our dependencies strictly go in the other direction: openedx-platform calls openedx-learning, not the other way around. Furthermore, openedx-learning will often be run without openedx-platform, such as for local development or during CI. | ||
| #. Two of the openedx-platform apps that have foreign keys to openedx-learning models are only in Studio's INSTALLED_APPS (``contentstore`` and ``modulestore_migrator``), while ``content_libraries`` is installed in both Studio and LMS. Migrations may be run for LMS or Studio first, depending on the user and environment. Tutor runs LMS first, but we can't assume that will always be true. | ||
| #. We must support people who are installing from scratch, those who are upgrading from the Ulmo release, as well as those who are running off of the master branch of openedx-platform. | ||
|
|
@@ -66,7 +68,7 @@ Therefore, the migrations will happen in the following order: | |
|
|
||
| The tricky part is that all the ``opendx-learning`` migrations will run before any of the ``openedx-platform`` migrations run. We can't force it to do otherwise without making ``openedx-learning`` aware of ``opendx-platform``, and we explicitly want to avoid that. This makes things tricky with respect to the model state dependencies. There are two scenarios we have to worry about: | ||
|
|
||
| Migration from Scrach | ||
| Migration from Scratch | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Another typo that makes me wonder how tired I was when I wrote this ADR. 😛 |
||
| The ``openedx-platform`` apps will each run the squashed migration that jumps straight to making foreign keys against the new ``openedx_content`` models, so the fact that the old authoring app models have been removed and the tables have been renamed doesn't matter. | ||
|
|
||
| Migration from Ulmo/master | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| .. _openedx-content-decisions-index: | ||
|
|
||
| Decisions | ||
| ========= | ||
|
|
||
| Architecture Decision Records for the ``openedx_content`` app. | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
| :glob: | ||
|
|
||
| * |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| .. _openedx-content-index: | ||
|
|
||
| openedx_content | ||
| =============== | ||
|
|
||
| Django app for modeling and authoring course content structures. | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| decisions/index | ||
| api_reference |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| .. _openedx-content-api: | ||
|
|
||
| Content API | ||
| =========== | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| .. _openedx-content-models-api: | ||
|
|
||
| Content Models | ||
| ============== | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| .. _openedx-core-adr-0001: | ||
|
|
||
| 1. Purpose of this Repo | ||
| ======================= | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| .. _openedx-core-decisions-index: | ||
|
|
||
| Decisions | ||
| ========= | ||
|
|
||
| Architecture Decision Records relating to the overall openedx-core repository. | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
| :glob: | ||
|
|
||
| * |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| .. _openedx-core-getting-started: | ||
|
|
||
| Getting Started | ||
| =============== | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was awkwardly large for the nav sidebar text, so I moved it to be at the start of the text instead.