Skip to content

Drop hosting at Read the Docs #1907

@stevepiercy

Description

@stevepiercy

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.
  • Monitor Matomo for changes in statistics

See also discussion from #1447.

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Status

    New

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions