docs icon indicating copy to clipboard operation
docs copied to clipboard

Documentation contained within package

Open camerongreen opened this issue 3 years ago • 1 comments

I was stuck with patchy wifi recently on a train journey and wanted to get some work done.

I've only recently started using Lando so I checked the rpm package for documentation.

$ rpm -ql lando
  
/usr/share/applications/lando.desktop
/usr/share/lando/bin/docker-compose
/usr/share/lando/bin/lando
/usr/share/lando/docs/LICENSE.md
/usr/share/lando/docs/PRIVACY.md
/usr/share/lando/docs/README.md
/usr/share/lando/docs/TERMS.md
/usr/share/lando/lando.png

Checking the README.md I mainly got links to the web. Did I miss something, or is that how it is?

For a specific example, I wanted to make some changes to my .lando,yml to add tooling but I had no idea what the available options were etc.

This could be fixed in a couple of ways, having the documentation in the package, or including a lando.example.yml in the package.

Anyway maybe an edge case, but would have been useful to have this.

camerongreen avatar Jan 02 '22 03:01 camerongreen