Changed documentation locations

Documentation
21

I'm not sure about the functionality of that ansible-playbook and the local-configure.yml file. Does this require merging, deployment, reload or the like?

IMO, for documentation we should have something much more agile.
Zope allows to traverse the subpath. Why not have Python methods which do so, and check for matches in a relational table?
E.g., we could have a documentation script, living in the root of https://plone.org, which of course knows about its name, and checks the table for an exact match for documentation and the subpath. If there is such a match, a redirection to the new location is performed (Plone 4 version, I'd say, because those old pages will almost certainly refer to Plone 4 or earlier). If there is no such exact match, (after a little "sorry" message) a form could be presented where the user can suggest a redirection target; administrators can view those targets and choose the best one.

Redirections which swallow path information (like /products to /download) are evil and should be removed. They are worse than nothing.

22

One more broken link: https://docs.plone.org/4/products/example.archetype/
(from https://docs.plone.org/4/en/old-reference-manuals/archetypes/a_simple_at_product/introduction.html)

I don't know the new location, thus I can't create a pull request.
Anyway, IMO we should be able to collect broken links (and the new locations) without them; see my suggestion about the database-based solution.

23

One more broken link: https://docs.plone.org/4/en/tutorial/customization-for-developers
(from https://docs.plone.org/4/en/old-reference-manuals/archetypes/a_simple_at_product/view_template.html)

24

If someone else were able to file issues in the docs repo that would be great! Tobias, thank you for finding these, but unless they're tracked at github.com/plone/documentation/issues your detective work will get lost in the shuffle.

Wildcard has kindly donated regular SiteImprove.com reports for plone.org and plone.com, and I'm actively fixing issues on plone.com but haven't enough time to manage the fixes for plone.org. But I see quickly above that Sven is running broken link checks on docs.plone.org already. I don't know who's actively fixing what's found in those reports.

25

Ok, I created an issue for the broken links.

Additionally I created another issue about that RDB-based redirection solution I sketched above.

1 Like
26

why you don't just install Products.RedirectionTool in the Plone site? that's the right tool for the task.

and BTW, this is still pending:

27

But this is about site-internal redirections, right? AFAICS, our main problem is to make those URLs https://plone.org/documentation/..., https://developer.plone.org/... and the like work again, by providing useful redirections ... and those are cross-site.

28

yes, you're right: I just tested and Products.RedirectionTool deals with internal redirections only.

29

There is another issue: Broken links in docs.plone.org

However, here are several comments collecting broken links, so I'll keep it that way.

30

Broken link: http://www.zope.org/Members/Zen/howto/FormVariableTypes, found on https://docs.plone.org/4/en/develop/plone/forms/manual.html#more-information (Plone 4 and Plone 5 versions).
The "new" location is http://old.zope.org/Members/Zen/howto/FormVariableTypes; I'll see into creating a pull request.
Perhaps it would be possible to establish a subpath-preserving permanent redirection from http://www.zope.org/Members/ to http://old.zope.org/Members/; who would be able to do this?

31

Lots of links are broken. If you go to https://stackoverflow.com/questions/tagged/plone?page=188&sort=newest&pagesize=15 for example and try to go to each question and each link provided by the users you would be surprised.

If you're really interested in collecting all possible broken links, maybe the stackexchange api will be nice. Get the ids from all questions tagged Plone in https://api.stackexchange.com/docs/advanced-search#order=desc&sort=activity&tagged=plone&filter=default&site=stackoverflow&run=true, use these ids to get the answers in https://api.stackexchange.com/docs/answers-on-questions and the comments https://api.stackexchange.com/docs/comments-on-answers and then extract all links from all answers and comments and check which one of them is broken.

The https://dev.plone.org/plone/ticket/6805 are now all broken, see Are we still using https://dev.plone.org/timeline? for an explanation.

32

@hvelarde it's ok... if people want RedirectionTool in core, they can just install CastleCMS
:slight_smile: