Merge pull request #1 from sbaerlocher/docs/inital

inital documentation
sbaerlocher · Jan 20, 2020 · ce47c19 · ce47c19
2 parents 104e6e2 + c6e2b10
commit ce47c19
Show file tree

Hide file tree

Showing 11 changed files with 415 additions and 26 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Changelog
+
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
+and [human-readable changelog](https://keepachangelog.com/en/1.0.0/).
+
+## master
+
+### Added
+
+- Initial docs
diff --git a/docs/index.html b/docs/index.html
@@ -1,23 +1,89 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8" />
-    <meta
-      name="viewport"
-      content="width=device-width, initial-scale=1, shrink-to-fit=no"
-    />
-    <title>My Docs</title>
-    <link rel="stylesheet" href="https://unpkg.com/docute@4/dist/docute.css" />
-  </head>
-
-  <body>
-    <div id="docute"></div>
-    <script src="https://unpkg.com/docute@4/dist/docute.js"></script>
-    <script>
-      new Docute({
-        target: '#docute',
-        title: 'Ansible Collection for Windows functions'
-      });
-    </script>
-  </body>
-</html>
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1, shrink-to-fit=no"
+    />
+    <title>My Docs</title>
+    <link rel="stylesheet" href="https://unpkg.com/docute@4/dist/docute.css" />
+  </head>
+
+  <body>
+    <div id="docute"></div>
+    <script src="https://unpkg.com/docute@4/dist/docute.js"></script>
+    <script>
+      new Docute({
+        target: '#docute',
+        title: 'Ansible Collection for Windows functions',
+        sourcePath:
+          'https://raw.githubusercontent.com/sbaerlocher/ansible.windows',
+        //  router: { mode: 'history' },
+        nav: [
+          {
+            title: 'Home',
+            link: '/'
+          },
+          {
+            title: 'GitHub',
+            link: 'https://github.com/sbaerlocher/ansible.windows'
+          },
+          {
+            title: 'Ansible Galaxy',
+            link: 'https://galaxy.ansible.com/sbaerlocher/windows'
+          }
+        ],
+        overrides: {
+          '/': {
+            language: 'English' // Used by the language dropdown menu in the sidebar
+          }
+        },
+        // Use `versions` option to add a version selector
+        // In the sidebar
+        versions: {
+          Latest: {
+            link: '/'
+          }
+        },
+        sidebar: [
+          // A sidebar item, with child links
+          {
+            title: 'Roles',
+            children: [
+              {
+                title: 'Directories',
+                link: '/roles/directories'
+              },
+              {
+                title: 'Disks',
+                link: '/roles/disks'
+              },
+              {
+                title: 'Local_Administrators',
+                link: '/roles/local_administrators'
+              },
+              {
+                title: 'Membership',
+                link: '/roles/membership'
+              },
+              {
+                title: 'OneDrive',
+                link: '/roles/onedrive'
+              },
+              {
+                title: 'Remote Desktop',
+                link: '/roles/remote_desktop'
+              }
+            ]
+          }
+        ],
+        footer: `
+      <div style="border-top:1px solid var(--border-color);padding-top:30px;margin: 40px 0;color:#999999;">
+      &copy; ${new Date().getFullYear()} sbaerlocher. Released under MIT license.
+      </div>
+      `
+      });
+    </script>
+  </body>
+</html>
diff --git a/galaxy.yml b/galaxy.yml
@@ -17,20 +17,20 @@ readme: README.md
 # A list of the collection's content authors. Can be just the name or in the format 'Full Name <email> (url)
 # @nicks:irc/im.site#channel'
 authors:
-  - 'Simon Bärlocher (https://sbaerlocher.ch)'
+  - 'Simon Baerlocher (https://sbaerlocher.ch)'
 
 ### OPTIONAL but strongly recommended
 
 # A short summary description of the collection
-description: 'Collection of Virtualization Software for Linux: VirtualBox, KVM, VMware, Docker-CE, Podman'
+description: 'Ansible Collection for Windows functions.'
 # Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only
 # accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file'
 license:
   - MIT
 
 # The path to the license file for the collection. This path is relative to the root of the collection. This key is
 # mutually exclusive with 'license'
-license_file: ''
+license_file: 'LICENSE'
 
 # A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character
 # requirements as 'namespace' and 'name'

diff --git a/roles/directories/README.md b/roles/directories/README.md
@@ -0,0 +1,39 @@
+# Ansible Role: directories
+
+## Description
+
+Creates a directory structure on the target system.
+
+## Role Variables
+
+### directories
+
+With directories you can specify a list of directories with subdirectories to be created on the target system.
+
+```yml
+directories:
+  - main: "{{ ansible_env.SystemDrive }}\\{{ directories_main }}"
+    subdirectories:
+      - 'facts.d'
+      - 'xml.d'
+      - 'tools.d'
+      - 'ansible'
+```
+
+### directories_main [Optional]
+
+Optional root directory to be created.
+
+```yml
+directories_main: Support
+```
+
+## Example Playbook
+
+```yml
+- hosts: all
+  collections:
+    - sbaerlocher.windows
+  roles:
+    - directories
+```
diff --git a/roles/disks/README.md b/roles/disks/README.md
@@ -0,0 +1,28 @@
+# Ansible Role: disks
+
+## Description
+
+Initializes, formats and mounts an additional disk on the target system.
+
+## Role Variables
+
+### disks
+
+A list of all devices to be included on the target system.
+
+```yml
+disks:
+  - disk_number: 1
+    drive_letter: D
+    new_label: Data
+```
+
+## Example Playbook
+
+```yml
+- hosts: all
+  collections:
+    - sbaerlocher.windows
+  roles:
+    - disks
+```
diff --git a/roles/local_administrators/README.md b/roles/local_administrators/README.md
@@ -0,0 +1,54 @@
+# Ansible Role: local_administrators
+
+## Description
+
+Ansible role that adds and removes users and groups to the Local Administrators group.
+
+## Role Variables
+
+### local administrators list
+
+A list of users or groups that Local Administrators
+should have rights to on the device.
+
+```yml
+local_administrators_defaults: []
+local_administrators_groups: []
+local_administrators_hosts: []
+```
+
+#### example local administrators list
+
+```yml
+local_administrators_defaults:
+  - UserX
+  - GroupX
+```
+
+### Pure Option
+
+If the state is enabled, only the specified elements will persist,
+and all other unspecified existing elements are removed.
+
+```yml
+local_administrators_pure_enable: false
+```
+
+### local administrators group
+
+Name of the local administrators group like e.g.
+English Administrators or German Administratoren
+
+```yml
+local_administrators_group: Administrators
+```
+
+## Example Playbook
+
+```yml
+- hosts: all
+  collections:
+    - sbaerlocher.windows
+  roles:
+    - local_administrators
+```
diff --git a/roles/membership/README.md b/roles/membership/README.md
@@ -0,0 +1,65 @@
+# Ansible Role: membership
+
+## Description
+
+Adds the target device to a domain or to a workgroup.
+
+## Role Variables
+
+### membership_domain_name
+
+the DNS name of the domain to which the targeted Windows host should be joined.
+
+```yml
+# membership_domain_name: ''
+```
+
+### membership_admin_user
+
+Username of a domain admin for the target domain (required to join or leave the domain).
+
+```yml
+membership_admin_user: ''
+```
+
+### membership_admin_password
+
+Password for the specified domain_admin_user.
+
+```yml
+membership_admin_password: ''
+```
+
+### membership_ou
+
+The desired OU path for adding the computer object. default: omit
+
+```yml
+membership_ou: '{{ omit }}'
+```
+
+### membership_state
+
+Whether the target host should be a member of a domain or workgroup.
+
+```yml
+membership_state: 'domain'
+```
+
+### membership_workgroup_name
+
+When state is workgroup, the name of the workgroup that the Windows host should be in.
+
+```yml
+# membership_workgroup_name: ''
+```
+
+## Example Playbook
+
+```yml
+- hosts: all
+  collections:
+    - sbaerlocher.windows
+  roles:
+    - membership
+```
diff --git a/roles/onedrive/README.md b/roles/onedrive/README.md
@@ -0,0 +1,31 @@
+# Ansible Role: onedrive
+
+## Description
+
+Disables or removes Microsoft OneDrive on a Windows 10 device.
+
+## Role Variables
+
+## onedrive_disable
+
+Disables OneDrive in the registry
+
+```yml
+onedrive_disable: true
+```
+
+## onedrive_remove
+
+Uninstalls OneDrive on the device.
+
+```yml
+onedrive_remove: false
+```
+
+## Example Playbook
+
+```yml
+- hosts: all
+  roles:
+    - sbaerlocher.windows.onedrive
+```