-
Type: Story
-
Status: Open (View Workflow)
-
Priority: Minor
-
Resolution: Unresolved
-
Affects Version/s: None
-
Fix Version/s: None
-
Component/s: None
-
Labels:
-
Story Points:2
-
Epic Link:
There appears to be a tendency to cite undocumented commands in tutorials and guides. Here's a couple of examples using onos-app:
1. "Simply type in ‘onos-app $OC1 install target/foo-app-1.0-SNAPSHOT.oar’"
2. onos-app localhost install target/foo-app-1.0-SNAPSHOT.oar
The list of Onos utility scripts in Appendix A does not include onos-app.
I'd suggest that no page on the wiki should use a command that cannot be linked to current documentation.
It may appear that giving simple 'noddy' instructions is best but it does nothing to build understanding.
All tutorials and guides should be examined for undocumented commands.