Skip to content
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

Create new RTD project for devstack #578

Open
timmc-edx opened this issue Mar 20, 2024 · 6 comments
Open

Create new RTD project for devstack #578

timmc-edx opened this issue Mar 20, 2024 · 6 comments
Labels
devstack Devstack fixes documentation Improvements or additions to documentation

Comments

@timmc-edx
Copy link
Member

timmc-edx commented Mar 20, 2024

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:

@timmc-edx timmc-edx converted this from a draft issue Mar 20, 2024
@robrap
Copy link
Contributor

robrap commented Mar 20, 2024

@robrap robrap added documentation Improvements or additions to documentation devstack Devstack fixes labels Apr 29, 2024
@robrap
Copy link
Contributor

robrap commented Apr 29, 2024

robrap added a commit to edx/devstack that referenced this issue Jun 24, 2024
This probably won't fix readthedocs for us, but
may get us one step closer.

See edx/edx-arch-experiments#578
robrap added a commit to edx/devstack that referenced this issue Jun 24, 2024
Provide some fixes for working with the edx fork of devstack.

Also see edx/edx-arch-experiments#578
robrap added a commit to edx/devstack that referenced this issue Jun 24, 2024
This probably won't fix readthedocs for us, but
may get us one step closer.

See edx/edx-arch-experiments#578
robrap added a commit to edx/devstack that referenced this issue Jun 24, 2024
Provide some fixes for working with the edx fork of devstack.

Also see edx/edx-arch-experiments#578
@robrap
Copy link
Contributor

robrap commented Jun 24, 2024

Additional notes:

@robrap
Copy link
Contributor

robrap commented Jun 25, 2024

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.

@jristau1984 jristau1984 moved this to Backlog in Arch-BOM Jul 1, 2024
robrap added a commit to edx/devstack that referenced this issue Jul 16, 2024
This probably won't fix readthedocs for us, but
may get us one step closer.

See edx/edx-arch-experiments#578
robrap added a commit to edx/devstack that referenced this issue Jul 16, 2024
Provide some fixes for working with the edx fork of devstack.

Also see edx/edx-arch-experiments#578
@robrap
Copy link
Contributor

robrap commented Jul 16, 2024

Some updates:

Once published to read the docs:

  • Restore README docs badge.

robrap added a commit to edx/devstack that referenced this issue Jul 16, 2024
We don't yet publish the docs from our 2U fork to
Read the Docs, so we are temporarily pointing 
directly to docs in GitHub.

The future publishing to Read the Docs for our 
fork is tasked here:
edx/edx-arch-experiments#578
@jristau1984
Copy link

@dianakhuang please confirm that the docs are up to date enough for this to be considered done. If so, close, if not, add additional tasks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devstack Devstack fixes documentation Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

3 participants