Repository navigation
README: add a quick start - #56
Merged
Merged
Conversation
verify-clone.sh also reads the config folder, and the builder refuses placeholder ANSIBLE_SSH_PUBKEY and UU_MAIL.
Clone, --init, edit one file, build with --verify.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
PR 5, the last of the series: a README quick start for newcomers, placed right after the intro. Stacked on #55 (base branch
init-config-dir); merge #55 first and GitHub retargets this to master.It walks through:
git clone --depth 1,./build-templates.sh --init, editing~/.config/ubuntu-templates/shared.conf(Ansible key, mail domain and relay choice ofgmail,customornone), then./build-templates.sh extras --verify --send-test-mail you@example.com, cloning the result in Proxmox, and updating withgit pull.Documentation only; no script changes. Every option mentioned exists on master or in #55.
Testing
Not run on a real host. Checked the text against
--help,shared.conf.exampleand the current guards: the builder refuses the example Ansible key, mail domain and mail addresses, but notCI_SSH_KEY,DOTFILES_RAWorWAKATIME_CFG, so the quick start tells the reader to set or blank those.