Skip to content

Conversation

@jameshcorbett
Copy link
Member

No description provided.

Problem: `flux-coral2` is not one of the subprojects listed, but it
should be now that it has its own documentation.

Add it.
Copy link
Member

@cmoussa1 cmoussa1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@jameshcorbett
Copy link
Member Author

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.

@garlick
Copy link
Member

garlick commented Apr 8, 2025

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!)

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
Copy link
Member Author

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 warning banner. Setting MWP.

@jameshcorbett jameshcorbett added the merge-when-passing mark PR for auto-merging by mergify.io bot label Apr 9, 2025
@mergify mergify bot merged commit f43f753 into flux-framework:master Apr 9, 2025
7 checks passed
@jameshcorbett jameshcorbett deleted the coral2-docs branch April 9, 2025 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

merge-when-passing mark PR for auto-merging by mergify.io bot

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants