Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proxito: document custom prefixes feature #11324

Open
stsewd opened this issue May 13, 2024 · 1 comment
Open

Proxito: document custom prefixes feature #11324

stsewd opened this issue May 13, 2024 · 1 comment
Labels
Needed: design decision A core team decision is required Needed: documentation Documentation is required

Comments

@stsewd
Copy link
Member

stsewd commented May 13, 2024

What's the problem this feature will solve?

Custom prefixes for projects and subprojects were implemented in #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.

@stsewd stsewd added Needed: documentation Documentation is required Needed: design decision A core team decision is required labels May 13, 2024
@agjohnson
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: design decision A core team decision is required Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

2 participants