summaryrefslogtreecommitdiff
path: root/roles
diff options
context:
space:
mode:
authorDan Fedele <dan.fedele@gmail.com>2023-06-13 10:53:59 -0400
committerDan Fedele <dan.fedele@gmail.com>2023-06-13 10:53:59 -0400
commit5610d030dda5d14ff62fb1a5eddcd1f3683fd6b8 (patch)
tree13bcfb4f4fc63e250aba6182f813220b2ea7c6ad /roles
parent61d2136b432a041e5bf1dc04503fa5fb05a60631 (diff)
Modified various readmes
Diffstat (limited to 'roles')
-rw-r--r--roles/custom-config/README.md36
-rw-r--r--roles/individual-apps/README.md33
-rw-r--r--roles/package-mgmt/README.md33
3 files changed, 5 insertions, 97 deletions
diff --git a/roles/custom-config/README.md b/roles/custom-config/README.md
index 225dd44..9a20a30 100644
--- a/roles/custom-config/README.md
+++ b/roles/custom-config/README.md
@@ -1,38 +1,4 @@
Role Name
=========
-A brief description of the role goes here.
-
-Requirements
-------------
-
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
-
-Role Variables
---------------
-
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
-
-Dependencies
-------------
-
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
-
-Example Playbook
-----------------
-
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-
- - hosts: servers
- roles:
- - { role: username.rolename, x: 42 }
-
-License
--------
-
-BSD
-
-Author Information
-------------------
-
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+This role handles customization of the desktop experience only. Adding things like zsh functions I use, getting rid of mouse interactivity with vim (because who in their right mind thought this was a good idea???), and other small tweaks that I needed. Put customization in here.
diff --git a/roles/individual-apps/README.md b/roles/individual-apps/README.md
index 225dd44..004e8b6 100644
--- a/roles/individual-apps/README.md
+++ b/roles/individual-apps/README.md
@@ -1,38 +1,9 @@
Role Name
=========
-A brief description of the role goes here.
-
-Requirements
-------------
-
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+This role will install individual packages that are _not_ tied to the package management system, IE apt. This also applies to git repositories and the like, as well as one-off compilation and build instructions, such as JumboJohn and Kerbrute.
Role Variables
--------------
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
-
-Dependencies
-------------
-
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
-
-Example Playbook
-----------------
-
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-
- - hosts: servers
- roles:
- - { role: username.rolename, x: 42 }
-
-License
--------
-
-BSD
-
-Author Information
-------------------
-
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+Just using a link to the compiled ysoserial .jar file.
diff --git a/roles/package-mgmt/README.md b/roles/package-mgmt/README.md
index 225dd44..2c23fcf 100644
--- a/roles/package-mgmt/README.md
+++ b/roles/package-mgmt/README.md
@@ -1,38 +1,9 @@
Role Name
=========
-A brief description of the role goes here.
-
-Requirements
-------------
-
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+This role will handle any OS-level patching and package installs, including the installation of keys for repositories and such. This role typically takes a while to run because I always make sure I am patched and up to date before doing anything, and then of course the individual packages just take a while to install.
Role Variables
--------------
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
-
-Dependencies
-------------
-
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
-
-Example Playbook
-----------------
-
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-
- - hosts: servers
- roles:
- - { role: username.rolename, x: 42 }
-
-License
--------
-
-BSD
-
-Author Information
-------------------
-
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+I have added the URLs to the specific keys I am using to install the repositories for things like Docker and Sublime Text.