Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
URL for revised Zope 2 book #443
Once the Zope 2 book gets revised for the upcoming release of Zope 4, what will be the URL for it?
Currently it is
Will we keep the Zope 2 book and its URL and create a new one for the Zope 4 book?
Or delete the old one and replace it with the new one and a possible new URL?
There are lots of references out there to the Zope 2 book - also still lots of references to doc.zope.org...
There should be a plan before the book gets updated.
It looks like readthedocs.org supports user-defined redirects that fire when a 404 is encountered:
So you could simply
As I already mentioned in #485 I'd really like to have a quick documentation how the documentation workflow is and who is involved. Maybe we could amend https://zope.readthedocs.io/en/latest/maintenance.html with a section about documentation? Or create a new document?
Does not have to be lengthy, just how the docs get build, who is involved, and maybe how to contribute. What are the recommended line lengths for rst files? If one changes the docs, do I need to be a Zope contributor? Skip CI for doc only changes?...
@jugmac00 @icemac So I have done the move as proposed in my previous comment and it all seems to work just fine. "The Zope Book" is at https://zope.readthedocs.io/en/latest/zopebook/. Document URLs that pointed to
I have also changed the (very few) internal links inside the
To answer Jürgens questions I have added a document maintenance section, please see https://zope.readthedocs.io/en/latest/maintenance.html.
Let me know if we can close this task.
@dataflake Thanks so much for your time and effort. Especially for these "non-criticial" issues.
The new section in the maintenance document reads very well.
I do not know whether writing "push request" was intentional (vs. github speak: pull request).
I wanted to send you the corresponding line in the github repo, so I hit the "Edit on github" link in the upper right corner of https://zope.readthedocs.io/en/latest/maintenance.html - which seems to be broken.
Which I guess has nothing to do with your changes.
The "Edit on github" links for the zopebook are also broken - I cannot recall whether this was already before.
Unfortunately, I have no experience with maintaining documentation on readthedocs nor much time to investigate.
At least during the sprint I hope I am able to contribute again.
I proposed the update of the changed url (zope2book -> zopebook) on Zope's German WikiPedia-Page.
Currently not yet published.
But except for @jhinghaus who added the links to the documentation I see no familiar names.
Luckily, WikiPedia makes it easy to update content - provided you got an account.