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

Set up a redirect from Read the Docs to official Plone 6 Documentation #547

Closed
wants to merge 1 commit into from

Conversation

stevepiercy
Copy link
Contributor

@stevepiercy stevepiercy commented Dec 18, 2024


📚 Documentation preview 📚: https://ploneapi--547.org.readthedocs.build/

@mister-roboto
Copy link

@stevepiercy thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

@stevepiercy
Copy link
Contributor Author

I only opened and closed this pull request to notify interested parties that I created a new branch to redirect documentation from Read the Docs to the official plone.api documentation. @ericof @davisagli in RTD, I configured the default branch to be this one, and removed main from the configuration. Thus RTD's "latest" always points to this branch. RTD requires one branch to be the default, and this redirect shenanigans is the only workaround I know of.

@stevepiercy
Copy link
Contributor Author

To test this deployment, try visiting https://ploneapi.readthedocs.io/

@davisagli
Copy link
Member

@stevepiercy Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants