From d6170be41dde5e5fbbbeea7ab7150d6c76613755 Mon Sep 17 00:00:00 2001 From: Shaun Reed Date: Sat, 31 Aug 2019 03:08:24 -0400 Subject: [PATCH] Fix READMEs --- README.md | 55 +++++++++++++++++++++--------------- ansible/README.md | 8 +++--- ansible/roles/README.md | 24 +++++++++------- ansible/roles/core/README.md | 23 ++++++++------- 4 files changed, 64 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index afd6bad..b3ab523 100644 --- a/README.md +++ b/README.md @@ -43,16 +43,20 @@ klips/ ### ansible Ansible roles, playbooks + +Playbooks - apt-up.yml - Playbook to update servers / groups ad hoc - core.yml - Playbook example for using core configuration role - docker.yml - Playbook example for using docker install role (Debian / Ubuntu) - hosts - Sample / partially default ansible hosts file - make-host.yml - Playbook example for using multiple roles together to create a new host - - nginx.yml - Playbook example for using nginx role - - roles - Some simple Ansible roles created with `ansible-galaxy init --offline` command - - core - Role to configure a new host with basic authentication / package settings - - docker - Role to install docker, docker-compose, configure docker user group (Debian / Ubuntu) - - nginx - Role to install and configure a new nginx webserver on a host + - nginx.yml - Playbook example for using nginx role + +Roles + - Basic ansible role created with ansible-galaxy command + - core - Role to configure a new host with basic authentication / package settings + - docker - Role to install docker, docker-compose, configure docker user group (Debian / Ubuntu) + - nginx - Role to install and configure a new nginx webserver on a host ### configs - .vimrc - Various settings for vim, can be copied or used with setup-vim.sh) @@ -66,22 +70,29 @@ Ansible roles, playbooks - doxygenROT - Basic rule-of-thumb for Doxygen commenting ### scripts - - adduser.sh - Script to add new user, run with sudo if you want to configure / allow user to sudo - - ./adduser - (Print help text) - - ./adduser - (Don't need sudo if new user doesn't need it) - - sudo ./adduser - - sudo ./adduser jeff 1005 - (Create jeff user and assign userID to 1005) - - Follow prompts to configure password / sudo depending on needs of new user - - cmake-build.sh - Script to toss around and build cmake projects - - README.md - Further clarification of scripts - - setup-vim.sh - Script for setting up vim configuration - - Includes Pathogen Plugin manager - - Includes auto-completion (Clang_completion) - - Supertab completion interaction (Tab to interact with completion context) - - Syntax highlighting - - Tabsize 2, use spaces in place of tabs - - auto indentation, mouse interaction when supported - - Custom keybind (Ctrl-e for jumping windows || Ctrl-w still works if not in a tabbed terminal where the same will close the tab) - - See klips/configs/.vimrc-README for more information + +adduser.sh - Script to add new user, run with sudo if you want to configure / allow user to sudo + - `./adduser` - (Print help text) + - `./adduser ` - (Don't need sudo if new user doesn't need it) + - `sudo ./adduser ` + - `sudo ./adduser jeff 1005` - (Create jeff user and assign userID to 1005) + - Follow prompts to configure password / sudo depending on needs of new user + +cmake-build.sh + - Script to toss around and build cmake projects + +README.md + - Further clarification of scripts + +setup-vim.sh + - Script for setting up vim configuration + - Includes Pathogen Plugin manager + - Includes auto-completion (Clang_completion) + - Supertab completion interaction (Tab to interact with completion context) + - Syntax highlighting + - Tabsize 2, use spaces in place of tabs + - auto indentation, mouse interaction when supported + - Custom keybind (Ctrl-e for jumping windows || Ctrl-w still works if not in a tabbed terminal where the same will close the tab) + - See klips/configs/.vimrc-README for more information diff --git a/ansible/README.md b/ansible/README.md index 3063d8e..9297480 100644 --- a/ansible/README.md +++ b/ansible/README.md @@ -11,8 +11,8 @@ Playbooks - nginx.yml - Playbook example for using nginx role Roles - - roles - Basic ansible role created with ansible-galaxy command - - core - Role to configure a new host with basic authentication / package settings - - docker - Role to install docker, docker-compose, configure docker user group (Debian / Ubuntu) - - nginx - Role to install and configure a new nginx webserver on a host + - Basic ansible role created with ansible-galaxy command + - core - Role to configure a new host with basic authentication / package settings + - docker - Role to install docker, docker-compose, configure docker user group (Debian / Ubuntu) + - nginx - Role to install and configure a new nginx webserver on a host diff --git a/ansible/roles/README.md b/ansible/roles/README.md index 9c82b94..42613a2 100644 --- a/ansible/roles/README.md +++ b/ansible/roles/README.md @@ -9,21 +9,25 @@ klips/ansible/roles/... All of these roles assume you are using the apt package manager, and running a Debian / Ubuntu system. + core ------------ A simple role for configuring a set of packages / settings on a new Ubuntu host using Ansible. -Packages Added / Configured - - Git - - Configure / set user name and email - - SSH - - MOTD (Template, replacable, displayed on login.) - - PAM (Template, replacable, authusers file to bypass) - - authusers (Add users to file to bypass PAM settings) - - Vim - - Install Vim - - Run https://github.com/shaunrd0/klips/blob/master/scripts/setup-vim.sh +### Packages Added / Configured + +Git + - Configure / set user name and email + +SSH + - MOTD (Template, replacable, displayed on login.) + - PAM (Template, replacable, authusers file to bypass) + - authusers (Add users to file to bypass PAM settings) + +Vim + - Install Vim + - Run https://github.com/shaunrd0/klips/blob/master/scripts/setup-vim.sh docker diff --git a/ansible/roles/core/README.md b/ansible/roles/core/README.md index 2cfbb5f..8cb45da 100644 --- a/ansible/roles/core/README.md +++ b/ansible/roles/core/README.md @@ -3,16 +3,19 @@ core A simple role for configuring a set of packages / settings on a new Ubuntu host using Ansible. -Packages Added / Configured - - Git - - Configure / set user name and email - - SSH - - MOTD (Template, replacable, displayed on login.) - - PAM (Template, replacable, authusers file to bypass) - - authusers (Add users to file to bypass PAM settings) - - Vim - - Install Vim - - Run https://github.com/shaunrd0/klips/scripts/setup-vim.sh +### Packages Added / Configured + +Git + - Configure / set user name and email + +SSH + - MOTD (Template, replacable, displayed on login.) + - PAM (Template, replacable, authusers file to bypass) + - authusers (Add users to file to bypass PAM settings) + +Vim + - Install Vim + - Run https://github.com/shaunrd0/klips/scripts/setup-vim.sh Requirements ------------