Documentation is broken is so many ways

Bug #2054312 reported by Oz123
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
MAAS
Status tracked in 3.6
3.5
Won't Fix
Medium
Unassigned
3.6
Fix Committed
Medium
Unassigned

Bug Description

The current docuementation of MaaS is a mess.

A few examples:

1. I don't want to "Provide feedback" on the docs. I want to see link to sources code, so I can specifically comment on issues.
2. The documentation in: https://maas.io/docs/fresh-installation-of-maass shows a subcommand `maas status`, however this subcommand is removed ...
3. The section Configure MAAS: Shows maas login $PROFILE $MAAS_URL < api-key-file, however this subcommand does not work with <. What does work is : maas login $PROFILE $MAAS_URL < $(cat api-key-file)

Revision history for this message
Alexsander de Souza (alexsander-souza) wrote :

Hi,

MAAS is currently rolling out new documentation, so unfortunately some errors might occur (like showing commands that don't exist in a given version). We apologise for any inconvenience.

About first point, there's a "Help improve this document in the forum." link in the bottom of all pages. This leads to a Wiki-like version of the current page in Discourse, where you can either edit it directly or just add a comment to topic explaining the issue.

Changed in maas:
status: New → Triaged
milestone: none → 3.5.0
Changed in maas-doc:
assignee: nobody → Bill Wear (billwear)
importance: Undecided → Medium
milestone: none → 3.5.0
status: New → Triaged
Changed in maas:
importance: Undecided → Medium
Changed in maas:
milestone: 3.5.0 → 3.5.x
tags: added: bug-council
Revision history for this message
Jerzy Husakowski (jhusakowski) wrote :

Thank you for your feedback! We aim to keep the docs fresh and current, but sometimes miss things. MAAS docs live in https://git.launchpad.net/maas/tree/src/maas-offline-docs if you'd like to submit a Merge Proposal with fixes. Alternatively, you can edit the docs on Discourse by clicking the "Help improve this document in the forum." - we regularly integrate community edits done this way.

Regarding your 2nd issue - maas status still works, what's the issue you're running into?
Thanks for pointing out the 3rd issue, we're fixing it now and the docs should be reflect this soon.

Changed in maas-doc:
milestone: 3.5.0 → none
no longer affects: maas-doc
tags: removed: bug-council
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.