Create new RTD project for devstack

edx / edx-arch-experiments

A plugin to include applications under development by the architecture team at edx

GNU Affero General Public License v3.0

0 stars 3 forks source link

Create new RTD project for devstack #578

Open timmc-edx opened 4 months ago

timmc-edx commented 4 months ago

The openedx/devstack repo was archived, and we have forked it to edx/devstack. Now that Axim is no longer maintaining the repo, we'll need to set up our own 2U version of the docs. Maybe call it "edX Devstack" or "2U/edX Devstack", rather than "Open edX Devstack".

Notes:

The old openedx project is at: https://readthedocs.org/projects/open-edx-devstack/
We should update the README badge and links to point to our build
TBD: What to do with the old docs

robrap commented 4 months ago

We might want to use the announce email to announce the move of the repo (and the docs).
We might want to update our version of https://edx.readthedocs.io/projects/open-edx-devstack/en/latest/manual_upgrades.html with notes on what to look for and how to update if needed.
If we choose to do some of the above, this ticket may be a blocker on the next-level of announcing.

robrap commented 2 months ago

Probably requires this to be updated: https://github.com/edx/devstack/blob/36f1bcd73255d02c162c9c3f88e853490216e585/docs/conf.py#L168

robrap commented 3 weeks ago

Additional notes:

Here's a PR with a variety of updates, but I'm not sure if I'll land it before this ticket is picked up: https://github.com/edx/devstack/pull/20
New PRs default to be against openedx-unsupported/devstack. Can we fix that? See https://github.com/edx/devstack/pull/20#discussion_r1651578462. Or should we just mention it in the docs for now?
The docs and repo have a variety of references to openedx that should be reviewed.
Gihub issues are not even enabled for edx/devstack.
- Do we want to enable for devstack? For all our forks and in our forking instructions?
- If so, we should test to ensure our Bug Report template starts working again.
We need to update links like https://github.com/edx/devstack/blame/18d97a7d4a3810b303663fafd2e9f8031a0c2899/docs/troubleshoot_general_tips.rst#L334-L335
- Do we need to migrate open tickets?
Created https://github.com/openedx/axim-engineering/issues/1173

robrap commented 3 weeks ago

More notes:

The devstack README is extremely out of date. DEPR, Tutor, etc. No mention of it being a private 2U fork.
A long or short term alternative is to remove the link to RTD and just point to the docs in github.
- Where is our private RTD? Do we have one?
We have no links to or discussion of our Colima wiki doc.

Consider a new ticket with a quick pass at updating the README, and possibly pointing to this ticket for other issues with the docs.

robrap commented 3 days ago

Some updates:

Once published to read the docs:

[ ] Restore README docs badge.