Point documentation links to Read the Docs
jerivas opened this issue · 7 comments
Discussed in #2029
Originally posted by blitzd March 28, 2022
Hey - the documentation site seems to be offline since sometime mid last week. Just a heads up - http://mezzanine.jupo.org/sites/
Links should now point to https://mezzanine.readthedocs.io/en/latest/
As I suggested at #2034, pointing to the section of the correct section of the docs (instead of just the root of the docs, and instead of search-and-replace for the domain) would ensure that the readme remains as useful as it was when the links went to the correct instructions.
@jerivas The https://mezzanine.readthedocs.io/en/latest/ shows the 4.3.1 documentation. Can you update to latest please?
Actually I just added an automatic documentation generation to gh actions.
The documentation is in the gh-pages branch and to make it accessible under http://mezzanine.jupo.org/, we need only to activate gh-pages in the settings and create a CNAME record for mezzanine.jupo.org which points to stephenmcd.github.io.
The same for cartridge.
This has to be done by @stephenmcd, and I already mailed him still waiting for the answer.
Here the relevant parts of the mail, just to have the information here:
Actually I'm now adding the CNAME files directly to the gh-page branches through the gh action, so it should be enough if you create CNAME entries for mezzanine.jupo.org and cartridge.jupo.org which both point to stephenmcd.github.io.
Then activate gh-pages in the settings. You don't need to specify the custom domain as this is already done adding the CNAME file to the gh-pages branch.
After the certificate is ready you should also set "Enforce HTTPS".
Here are the docs for managing a custom domain for gh-pages:
https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site
And here some details about the CNAME file which will be added to the gh-pages branch:
https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages#cname-errors
As I recreate the branch within gh actions on each build the CNAME file will be re-added through the action.
I like the project so I created a new website for it that I would love to give to the community free of charge
https://mezzanine.netlify.app/
Its a Vue based website with no extra modules.
Next Steps:
- Build out the modules and showcase sections from the official documentation section
i don't use coustom domain but in the page section i will get the problems shown in the image
