Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better descriptions / man pages / help texts #115

Open
lukas2511 opened this issue Oct 19, 2015 · 2 comments
Open

Better descriptions / man pages / help texts #115

lukas2511 opened this issue Oct 19, 2015 · 2 comments
Assignees

Comments

@lukas2511
Copy link
Contributor

Some of your scripts are missing good descriptions (e.g. oc-nbd-disconnect-root).

I'd suggest adding a section about those scripts to the official Scaleway documentation, adding man-pages and implementing "--help" functionality.

Also for some scripts like "oc-nbd-disconnect-root" it would be really nice to have a "--yes-do-it-i-know-what-im-doing" switch for them to actually do something.

@moul
Copy link
Contributor

moul commented Oct 19, 2015

👍 for better documentation in the scripts.

Note: about the specific oc-nbd-disconnect-root, this script is now deprecated in new images , as the initrd is handling all the nbd connect/disconnect stuff, we let this file for now but it will be removed soon

@moul
Copy link
Contributor

moul commented Oct 19, 2015

cc @aimxhaisse @QuentinPerez

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants