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
Triaged
Medium
Unassigned
MAAS documentation
Triaged
Medium
Bill Wear

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
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.