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

Resolve the need to manually maintain the "Contribute to docs" link destination #186

Closed
MariaVrachni opened this issue Sep 7, 2017 · 6 comments · Fixed by #227
Closed

Comments

@MariaVrachni
Copy link

Summary

The footer of maas.io contains a link "Contribute to documentation" which takes the user to the Writing Guide (currently @ https://docs.ubuntu.com/maas/2.1/en/contributing-writing). The guide is linked to a MAAS version and with any version updates we need to manually update the link on the footer. One solution would be to move the guide to a subset of docs that is not linked to any versions. Another solution would be to automate the link update with any new docs update.

@MariaVrachni
Copy link
Author

@nottrobin
Copy link
Contributor

The ideal solution to this problem is outlined in #99 (comment), and mainly depends on Redirect to latest version automatically being solved in docs.ubuntu.com, and ideally also two other issues being solved:

It would be wonderful if the MAAS squad could take on the task of prioritising and pushing this so those issues get addressed =)

@pmatulis
Copy link

pmatulis commented Sep 7, 2017

To be clear, my concern goes beyond this specific link. The Doc team should be able to link to the current stable version of any MAAS docs page without having to hardcode a version.

@nottrobin
Copy link
Contributor

@pmatulis I agree. I believe the issues I've mentioned address exactly that general problem. I'm just using MAAS as a vehicle to get it prioritised.

@pmatulis
Copy link

OK, but maybe the issue title should be changed.

@MariaVrachni
Copy link
Author

@pmatulis Feel free to change the issue title as you find appropriate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants