plone.restapi icon indicating copy to clipboard operation
plone.restapi copied to clipboard

Drop hosting at Read the Docs

Open stevepiercy opened this issue 8 months ago • 3 comments

We've had https://6.docs.plone.org/plone.restapi/docs/source/index.html for over 3 years now.

We've had https://plonerestapi.readthedocs.io/en/latest/ for longer.

I propose to terminate hosting of the RTD hosted version of the documentation for the following reasons.

  • A separate RTD host of the Plone REST API docs isolates and separates it from Plone 6.
  • It will improve the search engine experience for people who want to view Plone REST API docs in the context of Plone docs.
  • Currently the ratio of unique page views of Plone REST API docs on 6.docs.plone.org:RTD is 1.34:1 for the trailing 12 months, according to Matomo stats. For the previous trailing 12 months, it was 1.22:1. Plone 6 docs search engine indexing of these docs continues to improve.
  • It will stop stealing SEO from the Plone 6 Documentation.
  • We can continue to use pull request preview builds
  • We won't need to maintain it as a separate RTD project
  • I've set up a similar redirect for Volto

Tasks

  • [ ] Set up a single redirect on RTD to Plone 6 Documentation to avoid 404s and redirect SEO to the authoritative source
  • Update internal references to use the new URL for docs.
    • [ ] https://github.com/plone/plone.restapi/blob/7d49386e10811cf32da1d3014ec06b7fb0ed4c80/docs/source/upgrade-guide.md#L55-L55
    • [ ] https://github.com/plone/plone.restapi/blob/7d49386e10811cf32da1d3014ec06b7fb0ed4c80/CHANGES.md#L2609-L2609 and one more
    • [ ] https://github.com/plone/plone.restapi/blob/7d49386e10811cf32da1d3014ec06b7fb0ed4c80/README.md#L5-L5 and 2 more
  • [ ] Monitor Matomo for changes in statistics

See also discussion from https://github.com/plone/plone.restapi/issues/1447.

stevepiercy avatar Apr 11 '25 08:04 stevepiercy

@stevepiercy although it might have sense in the past, I think that nowadays having it separate has little sense.

I'd be +1 on this one.

sneridagh avatar Apr 11 '25 08:04 sneridagh

@stevepiercy +1

davisagli avatar Apr 15 '25 00:04 davisagli

@tisto I'd like your opinion because you previously objected, before I start work. Times have changed.

stevepiercy avatar Apr 15 '25 07:04 stevepiercy