readthedocs.org
readthedocs.org copied to clipboard
readthedocs
Proxito: document custom prefixes feature
What's the problem this feature will solve?
Custom prefixes for projects and subprojects were implemented in https://github.com/readthedocs/readthedocs.org/pull/10156, but we never documented them publicly. We have some internal docs about it in https://github.com/readthedocs/readthedocs.org/blob/main/readthedocs/proxito/README.rst#custom-path-prefixes.
We mention this feature in our pricing page (https://about.readthedocs.com/pricing/).
URL customization - Fine tune URLs used for your projects
We should link to our documentation from there with all the use cases this feature solves (proxying, removing or changing the "/projects" prefix).
There is also the discussion if we should expose this to users or manually handle this via support.
Yeah, I wouldn't mind exposing control of this as a beta feature/admin page as we are documenting it. Controlling this on behalf of users is tricky and requires scheduling changes and some back and forth. If users have this control they can remedy problems quicker.
I had a customer asking to remove the /projects/ part from the URL. It would be good to work on exposing this feature more in the UI so it can auto-sell itself when people see it as disabled from lower plans.
If they decided to pay for the Pro Plan, I will need to do this manually for them since they don't have a way to do it by themselves yet.
We are writing a blog post to promote this feature in https://github.com/readthedocs/website/pull/356 but it seems we don't have documentation for the feature yet.
That blog post isn't related to this feature, but to the ability of changing the version slug.