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

Hosted docs are out of date. #576

Open
tarek-y-ismail opened this issue Jun 5, 2024 · 3 comments
Open

Hosted docs are out of date. #576

tarek-y-ismail opened this issue Jun 5, 2024 · 3 comments
Labels
Enhancement New feature or request triaged We will be doing this

Comments

@tarek-y-ismail
Copy link

What needs to get done

The docs at https://craft-providers.readthedocs.io/en/latest/ seem to be out of date. Especially the explanations page which incorrectly link to LXD docs instead of Canonical docs. The source code for the page contains the correct link, so the hosted version just needs an update.

Why it needs to get done

The reason I came across this issue was because snapcraft failed and complained about network access. After digging through craft-provider's docs, LXD docs, and Canonical's docs, I finally managed to find the information I needed (uninstalling docker). I don't think that everyone will be stubborn enough to dig through all that.

@tarek-y-ismail tarek-y-ismail added the Enhancement New feature or request label Jun 5, 2024
@lengau lengau added the triaged We will be doing this label Jun 11, 2024
@lengau
Copy link
Contributor

lengau commented Jun 11, 2024

Thanks for the report! The up-to-date docs are available at https://canonical-craft-providers.readthedocs-hosted.com/en/latest/ but we should probably redirect to that from readthedocs.io.

Copy link

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-3013.

This message was autogenerated

@lengau
Copy link
Contributor

lengau commented Jul 16, 2024

@sergiusens @mr-cal I believe one of you probably has access to the readthedocs.io project?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request triaged We will be doing this
Projects
None yet
Development

No branches or pull requests

2 participants