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

Sample script in docs/mkcloud.md fails #2482

Open
GarySmith opened this issue Apr 12, 2018 · 0 comments
Open

Sample script in docs/mkcloud.md fails #2482

GarySmith opened this issue Apr 12, 2018 · 0 comments

Comments

@GarySmith
Copy link
Contributor

The documentation for mkcloud, docs/mkcloud.md, contains a sample bash script in the section "Using with local repositories". The biggest problem with this script is that it suggests that it can be used to create a full cloud and on casual reading seems to execute the additional setup steps mentioned at the top, such as creating the disk and loopback. But the problem is that it skips step (like setuphost) that have to be run in order to work properly. It also has a hardcoded path (/home/tom...) that make it unusable without tweaking. It also changes several network values for no apparent reason.
It appears that the whole point of the script was to demonstrate caching, so instead of having a script, it would be better to document how the caching options work, i.e. cache_clouddata and cache_dir.

dirkmueller added a commit to dirkmueller/automation that referenced this issue Apr 17, 2018
dirkmueller added a commit to dirkmueller/automation that referenced this issue Apr 17, 2018
jdsn added a commit that referenced this issue Apr 20, 2018
Make the wording clearer to address feedback in (#2482)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant