Skip to content

fix: broken URL for FAQ about attribute-error-list #1823

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

Merged
merged 1 commit into from
Jan 9, 2022
Merged

Conversation

JohnVillalovos
Copy link
Member

@JohnVillalovos JohnVillalovos commented Jan 9, 2022

The URL was missing a 'v' before the version number and thus the page
did not exist.

Previously the URL for python-gitlab 3.0.0 was:
https://python-gitlab.readthedocs.io/en/3.0.0/faq.html#attribute-error-list

Which does not exist.

Change it to:
https://python-gitlab.readthedocs.io/en/v3.0.0/faq.html#attribute-error-list
  add the 'v' --------------------------^

@JohnVillalovos JohnVillalovos requested a review from nejch January 9, 2022 18:42
@nejch
Copy link
Member

nejch commented Jan 9, 2022

@JohnVillalovos thanks for the catch!

I still see value in using versioned docs for this, in case we change things in the future.

It was just an oversight on our part with a missing v, the link is actually available here:
https://python-gitlab.readthedocs.io/en/v3.0.0/faq.html#attribute-error-list

WDYT?

We can also solve the existing issue on RTD with redirects either in the GUI (https://docs.readthedocs.io/en/stable/user-defined-redirects.html) or in sphinx directly for config as code (something like https://github.com/sphinx-contrib/redirects).

I plan on renaming gl_objects/ to resources/ to match upstream, so maybe I can add that then, as well, after I do some testing.

@JohnVillalovos
Copy link
Member Author

Oh sure. I can update to add the v. Sounds good!

The URL was missing a 'v' before the version number and thus the page
did not exist.

Previously the URL for python-gitlab 3.0.0 was:
https://python-gitlab.readthedocs.io/en/3.0.0/faq.html#attribute-error-list

Which does not exist.

Change it to:
https://python-gitlab.readthedocs.io/en/v3.0.0/faq.html#attribute-error-list
  add the 'v' --------------------------^
@nejch nejch merged commit 4a000b6 into main Jan 9, 2022
@nejch nejch deleted the jlvillal/fix_url branch January 9, 2022 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants