Reorganize docs by app#579
Conversation
Prior to this, the ADRs were in a global namespace, even though the actual content was very app-specific.
…o big for nav sidebar
|
I haven't manually reviewed these changes yet. I'll mark it as Ready for Review once I have. |
| - Clear separation between authoring configuration and computed learner state. | ||
| - Could allow different storage or scaling strategies for status data. | ||
| - Cons: | ||
| - Still introduces cross-app dependency and coordination for a single feature set. |
There was a problem hiding this comment.
Note: most of this is just removing extra whitespace that was breaking the docs build.
FYI @mgwozdz-unicon: Just a heads up about this issue. Please configure your text editor to strip extra whitespace.
| @@ -1,13 +1,13 @@ | |||
| Open edX Core: Foundational Packages for a Teaching & Learning Platform | |||
| ======================================================================= | |||
There was a problem hiding this comment.
This was awkwardly large for the nav sidebar text, so I moved it to be at the start of the text instead.
| 'Framework :: Django', | ||
| 'Framework :: Django :: 5.2', | ||
| 'Intended Audience :: Developers', | ||
| 'License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)', |
There was a problem hiding this comment.
This and the license formatting change above it are in response to docs warnings.
| :maxdepth: 1 | ||
| :glob: | ||
|
|
||
| 0* |
There was a problem hiding this comment.
[curious] is this a typo or does 0* have semantic meaning? Never seen the 0 part - https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-option-toctree-glob
There was a problem hiding this comment.
I interpreted it to mean that it's trying to match all the ADRs (which all start with "00XX-"), without grabbing images. Is there a more idiomatic way to do this?
There was a problem hiding this comment.
I guess it works fine with just * and ignores the images. I'll make that change, ty.
There was a problem hiding this comment.
What if we get to ADR-999??? What then!?!!?
(j/k... I totally missed that the children in this dir had 0 as their starting file name, I just thought it was some fancy RST shenanigans)
|
Swooning over |
For those that don't realize from the context, the only reason I know that was a thing to do is because @sarina gently pointed me to it. 😁 Thank you. |
| 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). |
There was a problem hiding this comment.
This was a typo that just irritated me too much to not fix when I ran across it.
| 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 |
There was a problem hiding this comment.
Another typo that makes me wonder how tired I was when I wrote this ADR. 😛
2 participants
This groups the ADRs by app and re-numbers them so that each app gets its own independent sequence of ADRs. It also reorganizes the top level docs accordingly, and fixes some docs build errors.
Claude did most of the heavy lifting on the refactoring end of this, while I mostly manually tweaked the top level organization and some of the text changes.
This is what it looks like:
FWIW, I expect this to the first of a number of PRs to fix up the docs in this repo before Verawood is officially released.