Apply issue template changes (#735)

With canonical/desktop-engineering#2, we defined
some yaml forms to be used as issue templates for reporting bugs and
requesting features on GitHub.

This provides a better and more defined way for users to interact with
us and provide us with the relevant information we need to solve the
problem.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,96 @@
+name: Report an issue
+description: Create a bug report to fix an issue
+title: 'Issue: '
+labels: 'bug'
+body:
+  - type: markdown
+    attributes:
+      value: >
+        :warning: **Please do not report security vulnerabilities here**
+
+        Be careful with sensitive information and security vulnerabilities. In order to report bugs that could contain
+        sensitive information, use [Launchpad](https://bugs.launchpad.net/ubuntu/+source/adsys/+filebug) instead.
+        On Ubuntu machines, you can use `ubuntu-bug adsys` to collect relevant information.
+
+
+        Thanks for taking the time to report an issue and help improve adsys! Please fill out the form below as
+        best as you can so that we can help you.
+
+        Your additional work here is greatly appreciated and will help us respond as quickly as possible. For general
+        support or usage questions, use [Ubuntu Discourse](https://discourse.ubuntu.com/c/desktop/8).
+
+        By submitting an Issue to this repository, you agree to the terms within the
+        [Ubuntu Code of Conduct](https://ubuntu.com/community/code-of-conduct).
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      options:
+        - label: I have searched the existing issues and found none that matched mine
+          required: true
+  - type: textarea
+    attributes:
+      label: Describe the issue
+      description: >
+        Provide a clear and concise description of what the issue is, including what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps to reproduce it
+      description: >
+        Detail the steps taken to reproduce this error, what was expected, and whether this issue can be reproduced
+        consistently or if it is intermittent.
+      placeholder: |
+        1. In this environment...
+        2. With this config...
+        3. Run '...'
+        4. See error...
+
+        Please include screenshots (you can drag any image here) where applicable. Redact any sensitive information.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Ubuntu users: System information"
+      description: >
+        Ubuntu users can run `ubuntu-bug adsys --save=/tmp/report.txt` and drag the file below.
+
+        It will contain useful information pertaining to the system and the packages installed.
+  - type: textarea
+    attributes:
+      label: "Non Ubuntu users: System information"
+      description: |
+        For users of distributions other than Ubuntu, provide details about the environment you experienced the issue in:
+      value: |
+        ### Environment
+        * adsys version: please run `adsysctl version`
+        * Distribution: (**NAME** in `/etc/os-release`)
+        * Distribution version: (**VERSION_ID** on `/etc/os-release`):
+
+        ### Log files
+        Please redact/remove sensitive information:
+        ```raw
+        adsys service logs can be acquired by running `adsysctl service cat -v`.
+        You can increase the amount of information displayed by increasing the verbosity level (-v) to -vv or -vvv.
+        ```
+
+        ### Application settings
+        Please redact/remove sensitive information:
+        ```raw
+        Paste the contents of your adsys.yaml file here, if you created one.
+        ```
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: >
+        Should there be any other contextual information that might be useful, please provide it here.
+        Please take a look at our [Troubleshooting guide](../#troubleshooting) to understand a bit more about what you
+        can do to get more information and logs about the project.
+      placeholder: Remember to redact any sensitive information from them.
+  - type: checkboxes
+    attributes:
+      label: Double check your logs
+      options:
+        - label: I have redacted any sensitive information from the logs
+          required: true
+

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,91 @@
+name: Request a feature
+description: Suggest new functionality or improvements for this project
+title: 'Feature: '
+labels: 'feature'
+body:
+  - type: markdown
+    attributes:
+      value: >
+        :warning: **Please do not report security vulnerabilities here**
+
+        Be careful with sensitive information and security vulnerabilities. In order to report bugs that could contain
+        sensitive information, use [Launchpad](https://bugs.launchpad.net/ubuntu/+source/adsys/+filebug) instead.
+        On Ubuntu machines, you can use `ubuntu-bug adsys` to collect relevant information.
+
+
+        Thanks for taking the time to report an issue and help improve adsys! Please fill out the form below as
+        best as you can so that we can help you.
+
+        Your additional work here is greatly appreciated and will help us respond as quickly as possible. For general
+        support or usage questions, use [Ubuntu Discourse](https://discourse.ubuntu.com/c/desktop/8).
+
+        By submitting an Issue to this repository, you agree to the terms within the
+        [Ubuntu Code of Conduct](https://ubuntu.com/community/code-of-conduct).
+  - type: checkboxes
+    attributes:
+      label: Is there an existing request for this feature?
+      options:
+        - label: I have searched the existing issues and found none that matched mine
+          required: true
+  - type: textarea
+    attributes:
+      label: Describe the feature
+      description: >
+        A clear and concise description of what the problem is. Ex.: \"I'm always frustrated when ...\"
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the ideal solution
+      description: >
+        A clear and concise description of what you want to happen.
+  - type: textarea
+    attributes:
+      label: Alternatives and current workarounds
+      description: >
+        A clear and concise description of any alternatives you've considered or any workarounds that are currently in
+        place.
+  - type: textarea
+    attributes:
+      label: "Ubuntu users: System information"
+      description: >
+        Ubuntu users can run `ubuntu-bug adsys --save=/tmp/report.txt` and drag the file below.
+
+        It will contain useful information pertaining to the system and the packages installed.
+  - type: textarea
+    attributes:
+      label: "Non Ubuntu users: System information"
+      description: |
+        For users of distributions other than Ubuntu, provide details about the environment you experienced the issue in:
+      value: |
+        ### Environment
+        * adsys version: please run `adsysctl version`
+        * Distribution: (**NAME** in `/etc/os-release`)
+        * Distribution version: (**VERSION_ID** on `/etc/os-release`):
+
+        ### Log files
+        Please redact/remove sensitive information:
+        ```raw
+        adsys service logs can be acquired by running `adsysctl service cat -v`.
+        You can increase the amount of information displayed by increasing the verbosity level (-v) to -vv or -vvv.
+        ```
+
+        ### Application settings
+        Please redact/remove sensitive information:
+        ```raw
+        Paste the contents of your adsys.yaml file here, if you created one.
+        ```
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: >
+        Should there be any other contextual information that might be useful, please provide it here.
+        Please take a look at our [Troubleshooting guide](../#troubleshooting) to understand a bit more about what you
+        can do to get more information and logs about the project.
+      placeholder: Remember to redact any sensitive information from them.
+  - type: checkboxes
+    attributes:
+      label: Double check your logs
+      options:
+        - label: I have redacted any sensitive information from the logs
+          required: true

README.md

@@ -1372,3 +1372,40 @@ adsysd runscripts ORDER_FILE [flags]
 For every commit on the `main` branch of the `adsys` repository, the GitHub Actions CI builds a development version of the `adwatchd` project. This is *NOT* a stable version of the application and should not be used for production purposes. However, it may prove useful to preview features or bugfixes not yet available as part of a stable release.
 
 To get access to the build artifact you need to be logged in on GitHub. Then, click on any passing run of the [QA workflow](https://github.com/ubuntu/adsys/actions/workflows/qa.yaml) that has the `Windows tests for adwatchd` job, and look for the `adwatchd_setup` file.
+
+## Troubleshooting
+
+If AD authentication works but adsys fails to fetch GPOs (e.g. you see `can't get policies` errors on login), please perform the following steps:
+
+1. Add the following to `/etc/samba/smb.conf`:
+
+```text
+log level = 10
+```
+
+2. Run `sudo login {user}@{domain}` in a terminal, replacing with your AD credentials
+
+3. Paste the output in the bug report
+
+The `adsysctl` command can also be useful to fetch logs for the daemon and client:
+
+```bash
+# You can increase the amount of information that will be displayed by using a more verbose tag (-vv or -vvv).
+# Note that this command will start a watcher that will print logs as they are generated, so you will need to perform
+# actions (such as trying to login) while the command is running.
+adsysctl service cat -v
+```
+
+Additionally, you can check the system journal to look at more logs about adsys:
+Remember that adsys runs with privileges, so you will need to run the following commands as root.
+
+```bash
+# You can use the -b flag to control how many boots the log will show (e.g. -b 0 will show the current boot only)
+journalctl -b0 | grep adsys
+
+# You can also get the logs of the individual units:
+systemctl list-units | grep adsys # this will show all adsys related systemd units
+
+# The -u flag will show the logs of the specified unit
+journalctl -b0 -u adsysd.service # this command will only show the adsysd.service logs of the current boot
+```