Merge pull request #102 from cipherstash/eql-docs-feedback

Docs: Enable docs feedback for EQL repo

Author: kateandrews

.github/ISSUE_TEMPLATE/docs-feedback.yml

@@ -0,0 +1,41 @@
+name: Docs feedback
+description: Feedback to help make our docs more effective.
+title: "[Docs]: "
+labels: ["docs", "triage"]
+assignees:
+  - kateandrews
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to give us feedback!
+  - type: input
+    id: contact
+    attributes:
+      label: Contact details
+      description: How can we get in touch with you if we need more info?
+      placeholder: you@example.com
+    validations:
+      required: false
+  - type: textarea
+    id: what-problem
+    attributes:
+      label: What problem were you trying to solve?
+      placeholder: Tell us what you were looking for in our docs.
+    validations:
+      required: true
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Anything else you'd like us to know?
+      placeholder: Let us know if you've got any additional feedback.
+    validations:
+      required: false
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of conduct
+      description: By submitting this issue, you agree to follow our [Code of conduct](https://github.com/cipherstash/proxy/blob/main/CODE_OF_CONDUCT.md). 
+      options:
+        - label: I agree to follow this project's Code of conduct
+          required: true

README.md

@@ -608,3 +608,9 @@ Limitations:
   All the containers bind to the same port (`7543`). If you want to run
   multiple containers at the same time, you have to change the ports by
   editing `tests/docker-compose.yml`
+
+---
+
+### Didn't find what you wanted?
+
+[Click here to let us know what was missing from our docs.](https://github.com/cipherstash/encrypt-query-language/issues/new?template=docs-feedback.yml&title=[Docs:]%20Feedback%20on%20README.md)

docs/concepts/WHY.md

@@ -89,3 +89,9 @@ For advanced users who prefer to handle encryption within their application:
 To get started using CipherStash's encryption is use solution, see the [Getting Started](https://github.com/cipherstash/encrypt-query-language/blob/main/GETTINGSTARTED.md) guide.
 
 For further help, raise an issue [here](https://github.com/cipherstash/encrypt-query-language/issues).
+
+---
+
+### Didn't find what you wanted?
+
+[Click here to let us know what was missing from our docs.](https://github.com/cipherstash/encrypt-query-language/issues/new?template=docs-feedback.yml&title=[Docs:]%20Feedback%20on%20WHY.md)

docs/reference/INDEX.md

@@ -239,3 +239,8 @@ SELECT cs_remove_index_v1(
   index_name text
 );
 ```
+---
+
+### Didn't find what you wanted?
+
+[Click here to let us know what was missing from our docs.](https://github.com/cipherstash/encrypt-query-language/issues/new?template=docs-feedback.yml&title=[Docs:]%20Feedback%20on%20INDEX.md)

docs/reference/JSON.md

@@ -880,3 +880,8 @@ Example data and params:
   "q": "ejson_path"
 }
 ```
+---
+
+### Didn't find what you wanted?
+
+[Click here to let us know what was missing from our docs.](https://github.com/cipherstash/encrypt-query-language/issues/new?template=docs-feedback.yml&title=[Docs:]%20Feedback%20on%20JSON.md)

docs/reference/MIGRATOR.md

@@ -70,3 +70,9 @@ cipherstash-migrator --columns test_text=encrypted_text test_jsonb=encrypted_jso
 
 - Ensure that the corresponding encrypted columns already exist in the table before running the migration.
 - Data migration operations should be tested in a development environment before being executed in production.
+
+---
+
+### Didn't find what you wanted?
+
+[Click here to let us know what was missing from our docs.](https://github.com/cipherstash/encrypt-query-language/issues/new?template=docs-feedback.yml&title=[Docs:]%20Feedback%20on%20MIGRATOR.md)

docs/reference/PAYLOAD.md

@@ -56,3 +56,9 @@ CipherStash Proxy handles the encoding, and EQL provides the functions.
 | o     | ORE index         | Ciphertext index value. Encrypted by Proxy.                                                                                                                                                                                                       |
 | u     | Unique index      | Ciphertext index value. Encrypted by Proxy.                                                                                                                                                                                                       |
 | sv    | STE vector index  | Ciphertext index value. Encrypted by Proxy.                                                                                                                                                                                                       |
+
+---
+
+### Didn't find what you wanted?
+
+[Click here to let us know what was missing from our docs.](https://github.com/cipherstash/encrypt-query-language/issues/new?template=docs-feedback.yml&title=[Docs:]%20Feedback%20on%20PAYLOAD.md)

docs/tutorials/GETTINGSTARTED.md

@@ -580,3 +580,9 @@ This query returns:
 This tutorial showed how we can go from a plaintext text field to an encrypted field and how to query the encrypted fields.
 
 We have some [examples here](../../README.md#helper-packages) of what this would look like if you are using an ORM.
+
+---
+
+### Didn't find what you wanted?
+
+[Click here to let us know what was missing from our docs.](https://github.com/cipherstash/encrypt-query-language/issues/new?template=docs-feedback.yml&title=[Docs:]%20Feedback%20on%20GETTINGSTARTED.md)

docs/tutorials/PROXY.md

@@ -83,3 +83,9 @@ At a high level:
 1. CipherStash Proxy decrypts any returned `ciphertext` data and returns to client
 
 ![Select](/diagrams/overview-select.drawio.svg)
+
+---
+
+### Didn't find what you wanted?
+
+[Click here to let us know what was missing from our docs.](https://github.com/cipherstash/encrypt-query-language/issues/new?template=docs-feedback.yml&title=[Docs:]%20Feedback%20on%20PROXY.md)