Content parameter for commissioning-scripts and node-scripts is not helpful
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| MAAS |
Triaged
|
Low
|
Bill Wear | ||
| 3.3 |
Triaged
|
Low
|
Bill Wear | ||
Bug Description
The docs on how to add commissioning scripts or node scripts via the CLI are wrong.
`maas <profile> commissioning-
The help text also does not say that the parameter requires an @ sign (e.g `content@=<path>`) so it does not work as it is documented today.
I recommend changing the parameter name to path and documenting the @ sign.
Source code:
* https:/
* https:/
* https:/
Please also update the docs: https:/
| Changed in maas: | |
| status: | New → Triaged |
| importance: | Undecided → Medium |
| milestone: | none → next |
| tags: | added: doc |
| summary: |
- [doc] [cli] content parameter for commissioning-scripts and node-scripts - is not helpful + Content parameter for commissioning-scripts and node-scripts is not + helpful |
| Jerzy Husakowski (jhusakowski) wrote | #1 |
| Changed in maas: | |
| assignee: | nobody → Bill Wear (billwear) |
| importance: | Medium → Low |
| milestone: | next → 3.3.0 |
| Changed in maas: | |
| milestone: | 3.3.0 → 3.4.0 |
| Changed in maas: | |
| milestone: | 3.4.0 → 3.4.x |
We will improve the https:/
The way that MAAS API and CLI documentation is created is contributing to this confusion. We are planning to revise the doc generation mechanism and the way that API is exposed, which should make it easier to improve the documentation as well. Until these improvements are in place, we are not able to meaningfully remove this type of confusion.