From 3feaca1ceaae794e93479282110f16e3fd6e6268 Mon Sep 17 00:00:00 2001 From: CchristiNana <139203070+CchristiNana@users.noreply.github.com> Date: Mon, 15 Apr 2024 19:51:06 +1000 Subject: [PATCH 01/10] feedback page creation --- astro.config.mjs | 9 +++++ src/content/docs/feedback/feedback form.md | 39 ++++++++++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 src/content/docs/feedback/feedback form.md diff --git a/astro.config.mjs b/astro.config.mjs index 41139d5e..085f6800 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -470,6 +470,15 @@ export default defineConfig({ }, ], }, + { + label: "Feedback", + items: [ + { + label: "Feedback", + link: "feedback/feedback-form", + }, + ], + }, ], }), ], diff --git a/src/content/docs/feedback/feedback form.md b/src/content/docs/feedback/feedback form.md new file mode 100644 index 00000000..c939ce35 --- /dev/null +++ b/src/content/docs/feedback/feedback form.md @@ -0,0 +1,39 @@ +--- +title: Feedback Form +description: a way to provide feedback +--- + +#### We Value Your Feedback + +Thank you for choosing to share your thoughts with us. Your feedback helps us improve and continue +providing the best experience possible. + +#### How to Provide Feedback + +You have several options for sending us your feedback. Please choose the one that suits you best: + +##### Option 1: Fill Out Our Online Form + +Please fill out our detailed feedback form available at [Our Feedback Form](link). It only takes a +few minutes! + +##### Option 2: Contact your team leader or senior students + +If you have specific feedback or concerns that require direct communication, please reach out to +your team leader or seniro students. This ensures that your feedback is addressed promptly and personally. + +--- + +#### What Happens Next? + +After you submit your feedback: + +- **We Review It:** All feedback is reviewed by our team to understand your needs and requirements. +- **We Plan:** We plan improvements based on the feedback we receive from you and other users. +- **We Implement:** We try out best to implement changes and improvements continuously to enhance your + experience. + +Your input is incredibly valuable to us, and we appreciate the time you take to help us improve. If +you have any immediate concerns, please don't hesitate to contact our company operation team. + +Thank you for your contribution! From b66a41ee159824e2904f24b91609879f53a04b4c Mon Sep 17 00:00:00 2001 From: CchristiNana <139203070+CchristiNana@users.noreply.github.com> Date: Mon, 15 Apr 2024 19:55:55 +1000 Subject: [PATCH 02/10] Update feedback form.md --- src/content/docs/feedback/feedback form.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/content/docs/feedback/feedback form.md b/src/content/docs/feedback/feedback form.md index c939ce35..a62c1f45 100644 --- a/src/content/docs/feedback/feedback form.md +++ b/src/content/docs/feedback/feedback form.md @@ -20,7 +20,8 @@ few minutes! ##### Option 2: Contact your team leader or senior students If you have specific feedback or concerns that require direct communication, please reach out to -your team leader or seniro students. This ensures that your feedback is addressed promptly and personally. +your team leader or seniro students. This ensures that your feedback is addressed promptly and +personally. --- @@ -30,8 +31,8 @@ After you submit your feedback: - **We Review It:** All feedback is reviewed by our team to understand your needs and requirements. - **We Plan:** We plan improvements based on the feedback we receive from you and other users. -- **We Implement:** We try out best to implement changes and improvements continuously to enhance your - experience. +- **We Implement:** We try out best to implement changes and improvements continuously to enhance + your experience. Your input is incredibly valuable to us, and we appreciate the time you take to help us improve. If you have any immediate concerns, please don't hesitate to contact our company operation team. From 5536c1fe50b67540d0865f1cc4b43f064b9575d7 Mon Sep 17 00:00:00 2001 From: CchristiNana <139203070+CchristiNana@users.noreply.github.com> Date: Sun, 28 Apr 2024 16:32:52 +1000 Subject: [PATCH 03/10] feedback form creation --- public/feedbackform.html | 92 ++++++++++++++++++++++ public/submitsuccess.html | 46 +++++++++++ src/content/docs/feedback/feedback form.md | 4 +- 3 files changed, 140 insertions(+), 2 deletions(-) create mode 100644 public/feedbackform.html create mode 100644 public/submitsuccess.html diff --git a/public/feedbackform.html b/public/feedbackform.html new file mode 100644 index 00000000..78c8f287 --- /dev/null +++ b/public/feedbackform.html @@ -0,0 +1,92 @@ + + + + + +Feedback Form + + + +
+

Feedback Page

+

We would love your feedback

+

Our goal is to make a platform that simplifies your workday. You’ve been using Thoth Tech Documentation Website for a while now, and we’d love to know what you think about it. We really appreciate your feedback!

+ +
+ + + + + +
+ +
+ + +
+ + + + +
+ + +
+
+ + diff --git a/public/submitsuccess.html b/public/submitsuccess.html new file mode 100644 index 00000000..90e069c5 --- /dev/null +++ b/public/submitsuccess.html @@ -0,0 +1,46 @@ + + + + + +Feedback Submitted + + + +
+

Feedback Submitted

+

We would love your feedback

+

Our goal is to make a platform that simplifies your workday. You’ve been using Thoth Tech Documentation Website for a while now, and we’d love to know what you think about it. We really appreciate your feedback!

+ +
+

Thanks for sharing your feedback with us

+

Your feedback has been submitted successfully.

+

Your input is valuable to us and will help us improve our services.

+
+
+ + diff --git a/src/content/docs/feedback/feedback form.md b/src/content/docs/feedback/feedback form.md index a62c1f45..08311432 100644 --- a/src/content/docs/feedback/feedback form.md +++ b/src/content/docs/feedback/feedback form.md @@ -14,8 +14,8 @@ You have several options for sending us your feedback. Please choose the one tha ##### Option 1: Fill Out Our Online Form -Please fill out our detailed feedback form available at [Our Feedback Form](link). It only takes a -few minutes! +Please fill out our detailed feedback form available at [Our Feedback Form](/feedbackform.html). It +only take a few minutes! ##### Option 2: Contact your team leader or senior students From d1e8a33d6f8c90150794e3e2fe891ab892352774 Mon Sep 17 00:00:00 2001 From: CchristiNana <139203070+CchristiNana@users.noreply.github.com> Date: Sun, 5 May 2024 19:47:46 +1000 Subject: [PATCH 04/10] update --- public/feedbackform.html | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/public/feedbackform.html b/public/feedbackform.html index 78c8f287..025f1108 100644 --- a/public/feedbackform.html +++ b/public/feedbackform.html @@ -69,10 +69,28 @@

Feedback Page

+<<<<<<< Updated upstream +======= +
+ +
+ + +
+ + + + +
+ + + +
+>>>>>>> Stashed changes
From 502f51af7d8d096e0a8852676994767d4cc48a64 Mon Sep 17 00:00:00 2001 From: CchristiNana <139203070+CchristiNana@users.noreply.github.com> Date: Sun, 5 May 2024 19:51:39 +1000 Subject: [PATCH 05/10] fix star rating order --- public/feedbackform.html | 20 +++----------------- 1 file changed, 3 insertions(+), 17 deletions(-) diff --git a/public/feedbackform.html b/public/feedbackform.html index 025f1108..03566960 100644 --- a/public/feedbackform.html +++ b/public/feedbackform.html @@ -23,6 +23,9 @@ .star-rating { text-align: center; font-size: 0; + display: flex; + flex-direction: row-reverse; /* Reverse the order of children */ + justify-content: center; } .star-rating input { display: none; @@ -69,12 +72,10 @@

Feedback Page

-<<<<<<< Updated upstream -=======
@@ -86,25 +87,10 @@

Feedback Page

-
->>>>>>> Stashed changes - -
- - -
- - - - -
- - -
From c6a7322545e997f7c2cb551aa5dda90b673c2478 Mon Sep 17 00:00:00 2001 From: CchristiNana <139203070+CchristiNana@users.noreply.github.com> Date: Sun, 5 May 2024 19:54:12 +1000 Subject: [PATCH 06/10] Update feedbackform.html --- public/feedbackform.html | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/public/feedbackform.html b/public/feedbackform.html index 03566960..8873d154 100644 --- a/public/feedbackform.html +++ b/public/feedbackform.html @@ -78,7 +78,7 @@

Feedback Page

-
+
@@ -87,6 +87,7 @@

Feedback Page

+
From 0c838d5b143cd35d9a4981634fbaae17b079d056 Mon Sep 17 00:00:00 2001 From: CchristiNana <139203070+CchristiNana@users.noreply.github.com> Date: Sun, 12 May 2024 23:19:42 +1000 Subject: [PATCH 07/10] create feedback form documentation --- astro.config.mjs | 4 ++ .../feedback/feedback form documentation.md | 52 +++++++++++++++++++ 2 files changed, 56 insertions(+) create mode 100644 src/content/docs/feedback/feedback form documentation.md diff --git a/astro.config.mjs b/astro.config.mjs index 085f6800..2ba9a33c 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -477,6 +477,10 @@ export default defineConfig({ label: "Feedback", link: "feedback/feedback-form", }, + { + label: "Feedback form documentation", + link: "feedback/feedback-form-documentation", + }, ], }, ], diff --git a/src/content/docs/feedback/feedback form documentation.md b/src/content/docs/feedback/feedback form documentation.md new file mode 100644 index 00000000..adc2f16d --- /dev/null +++ b/src/content/docs/feedback/feedback form documentation.md @@ -0,0 +1,52 @@ +--- +title: Feedback Form Implementation Documentation +description: Documentation of the feedback form setup for future maintenance and enhancement. +--- + +## Feedback Form Implementation Documentation + +### Overview + +This document outlines the implementation and setup of the feedback form used on the Thoth Tech +Documentation Website. It is intended to assist future students and developers in understanding the +current system and to facilitate further development and maintenance. + +### Tools Used + +- **HTML/CSS** for structuring and styling the form. +- **JavaScript** for front-end logic. +- **Web3Forms** for handling form submissions without server-side code. +- **Node.js** and **Express** for server-side logic in case of future custom backend integration. + +### Form Setup and Design + +The feedback form is designed to be simple yet functional, enabling users to quickly provide their +feedback on the Thoth Tech Documentation Website. It includes fields for user identification, +feedback content, and ratings: + +- **Name**: Allows the user to enter their name. +- **Email**: Allows the user to enter their email for follow-ups. +- **Feedback Type**: Users can select whether they are submitting a general suggestion or specific + improvement ideas. +- **Rating**: Users can rate their experience using star ratings. +- **Comments**: A textarea for additional comments. + +### Integration with Web3Forms + +Web3Forms is used to manage form submissions. This service was selected for its simplicity and the +ability to handle form submissions without the need for additional backend code, making it ideal for +projects with limited server-side interaction: + +#### How to Configure Web3Forms + +1. **API Key**: An API key is required from Web3Forms, which is included in the form's hidden input + field to authenticate requests. +2. **Form Action**: The form's `action` attribute is set to the Web3Forms endpoint URL. +3. **Method**: POST method is used to send data to the Web3Forms service. + +```html +
+ + +
+``` From 904038ef085a0ea58cfc9bc97e8a4e90709a2f40 Mon Sep 17 00:00:00 2001 From: CchristiNana <139203070+CchristiNana@users.noreply.github.com> Date: Fri, 17 May 2024 23:47:28 +1000 Subject: [PATCH 08/10] update --- astro.config.mjs | 4 +++ ...eedback storage and access instructions.md | 26 +++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 src/content/docs/feedback/feedback storage and access instructions.md diff --git a/astro.config.mjs b/astro.config.mjs index 2ba9a33c..36c03b69 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -481,6 +481,10 @@ export default defineConfig({ label: "Feedback form documentation", link: "feedback/feedback-form-documentation", }, + { + label: "Feedback storage and access instructions", + link: "feedback/feedback-storage-and-access-instructions", + }, ], }, ], diff --git a/src/content/docs/feedback/feedback storage and access instructions.md b/src/content/docs/feedback/feedback storage and access instructions.md new file mode 100644 index 00000000..f27e11ee --- /dev/null +++ b/src/content/docs/feedback/feedback storage and access instructions.md @@ -0,0 +1,26 @@ +--- +title: Feedback Storage and Access Instructions +description: Documentation of the feedback form setup for future maintenance and enhancement. +--- + +## Feedback Handling Documentation + +### Overview + +This document outlines how feedback submissions from our website are handled. The feedback is sent +to a dedicated email address and stored securely for review by authorized personnel. + +### Feedback Submission Process + +1. **Form Submission**: When users submit feedback through the feedback form on our website, the + data is sent directly to a specified email address. +2. **Email Storage**: The feedback is stored in the inbox of this email account for future reference + and review by the team. + +### Email Address Details + +The email address dedicated to receiving and storing feedback submissions is documented in our +Trello board. Access details are as follows: + +- **Trello Board**: Company Operation Board +- **List**: Company Website List From 7aca6ce3cb30f45b8056edd5b11fa1c6e04be42e Mon Sep 17 00:00:00 2001 From: CchristiNana <139203070+CchristiNana@users.noreply.github.com> Date: Fri, 17 May 2024 23:54:40 +1000 Subject: [PATCH 09/10] update file --- .../feedback/feedback storage and access instructions.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/content/docs/feedback/feedback storage and access instructions.md b/src/content/docs/feedback/feedback storage and access instructions.md index f27e11ee..73f3fb61 100644 --- a/src/content/docs/feedback/feedback storage and access instructions.md +++ b/src/content/docs/feedback/feedback storage and access instructions.md @@ -24,3 +24,9 @@ Trello board. Access details are as follows: - **Trello Board**: Company Operation Board - **List**: Company Website List + +```html +##Another place to look up the email address and password + +There is also a document in conpamy operation channel which includes the email address and password. +``` From 77e998e7e65b23853ea262fbb01df11cfadc205d Mon Sep 17 00:00:00 2001 From: CchristiNana <139203070+CchristiNana@users.noreply.github.com> Date: Fri, 17 May 2024 23:56:25 +1000 Subject: [PATCH 10/10] update --- .../feedback/feedback storage and access instructions.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/content/docs/feedback/feedback storage and access instructions.md b/src/content/docs/feedback/feedback storage and access instructions.md index 73f3fb61..13f72b6a 100644 --- a/src/content/docs/feedback/feedback storage and access instructions.md +++ b/src/content/docs/feedback/feedback storage and access instructions.md @@ -26,7 +26,6 @@ Trello board. Access details are as follows: - **List**: Company Website List ```html -##Another place to look up the email address and password - -There is also a document in conpamy operation channel which includes the email address and password. +##Another place to look up the email address and password There is also a document in conpamy +operation channel which includes the email address and password. ```