tutorials: deprecate coral2 docs in favor of flux-coral2#297
tutorials: deprecate coral2 docs in favor of flux-coral2#297mergify[bot] merged 2 commits intoflux-framework:masterfrom
flux-coral2#297Conversation
Problem: `flux-coral2` is not one of the subprojects listed, but it should be now that it has its own documentation. Add it.
cmoussa1
left a comment
cmoussa1
left a comment
There was a problem hiding this comment.
LGTM! Should we consider eventually just removing the coral2.rst, rabbit.rst, and rabbit_config.rst documents from this repo if there are newer versions that are maintained in the flux-coral2 ReadTheDocs?
Maybe it would be worth it to keep them here for now and just include a warning as you've done, which in this case just ignore me
|
I would remove them but I think there are external links to them and I don't want those to get 404s, at least not for a few months. |
|
There might be something to play with here: https://readthedocs-theme.readthedocs.io/en/latest/user-defined-redirects.html Not sure if that would work (and not sure why I didn't find it when I moved the admin guide!) |
jameshcorbett
force-pushed
the
coral2-docs
branch
from
22c68a9 to
0b50341
Compare
Problem: the `flux-coral2` repo provides its own documentation that is more up-to-date than what is provided here. Remove the documentation here. Redirects will be configured on the readthedocs page so that external links still work.
jameshcorbett
force-pushed
the
coral2-docs
branch
from
0b50341 to
dcb6012
Compare
|
Thanks for the pointer @garlick ! I set up some redirects on the readthedocs page and they seem to work so I removed the docs instead of adding a |
jameshcorbett
added
the
merge-when-passing
3 participants
No description provided.