From 87f095887288235399796bf079dcf5a1857741a9 Mon Sep 17 00:00:00 2001 From: aldbr Date: Mon, 9 Oct 2023 14:40:40 +0200 Subject: [PATCH] feat: github discussion templates --- .github/DISCUSSION_TEMPLATE/surveys.yaml | 92 +++++++++++++++++++ .../user-personas-and-stories.yaml | 51 ++++++++++ README.md | 49 ++++++---- 3 files changed, 173 insertions(+), 19 deletions(-) create mode 100644 .github/DISCUSSION_TEMPLATE/surveys.yaml create mode 100644 .github/DISCUSSION_TEMPLATE/user-personas-and-stories.yaml diff --git a/.github/DISCUSSION_TEMPLATE/surveys.yaml b/.github/DISCUSSION_TEMPLATE/surveys.yaml new file mode 100644 index 00000000..9aaa856a --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/surveys.yaml @@ -0,0 +1,92 @@ +title: "User Feedback Survey: []" +body: + - type: markdown + attributes: + value: > + We value your feedback and would love to hear about your experience with our current web application. + Your insights will be instrumental in shaping the new diracx-web client we are building. + Please take a moment to answer the questions below. + + - type: textarea + id: question-1 + attributes: + label: "1. Describe your overall experience with the current [DIRAC web application](https://github.com/DiracGrid/webAppDIRAC)." + description: > + Focus on aspects like ease of use, reliability, and speed + validations: + required: true + + - type: textarea + id: question-2 + attributes: + label: "2. What tasks do you primarily use our web application for?" + description: > + Example: Users monitor their jobs. + validations: + required: true + + - type: textarea + id: question-3 + attributes: + label: "3. What features do you find most useful and why?" + description: > + Example: The possibility of monitoring my jobs in real-time. + validations: + required: true + + - type: textarea + id: question-4 + attributes: + label: "4. Are there any features or functionalities you find frustrating or difficult to use?" + description: > + Example: Logs are hard to read. + validations: + required: true + + - type: textarea + id: question-5 + attributes: + label: "5. Have you encountered any bugs or issues while using the application? If so, describe them." + description: > + Example: Sometimes I see some messages I do not understand popping up in the interface. + validations: + required: true + + - type: textarea + id: question-6 + attributes: + label: "6. Are there any features or functionalities you wish were included in the current web application?" + description: > + Example: Yes, I would like to group my job by CE type! + validations: + required: true + + - type: textarea + id: question-7 + attributes: + label: "7. How do you feel about the current user interface and design? What changes, if any, would you suggest?" + validations: + required: true + + - type: textarea + id: question-9 + attributes: + label: "9. Have you ever used the DIRAC web application on mobile devices? Would a mobile-friendly version be beneficial for you?" + description: "The adoption of OIDC tokens will open up such possibilities" + validations: + required: true + + - type: textarea + id: question-10 + attributes: + label: "10. Is there anything else you would like to share or suggest as we work on the diracx-web application?" + validations: + required: true + + - type: markdown + attributes: + value: > + Thank you for taking the time to provide your feedback. + Your insights are valuable to us as we work on improving the application. + We will keep you updated on our progress and look forward to sharing the new version with you. + diff --git a/.github/DISCUSSION_TEMPLATE/user-personas-and-stories.yaml b/.github/DISCUSSION_TEMPLATE/user-personas-and-stories.yaml new file mode 100644 index 00000000..caf40c58 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/user-personas-and-stories.yaml @@ -0,0 +1,51 @@ +title: "[] " +body: + - type: markdown + attributes: + value: > + Develop a user persona and a story to capture the goals and tasks your users want to accomplish with diracx-web. + We are interested in understanding your needs and goals. Please focus on what you want to achieve rather than how you think it should be achieved. + All ideas are welcome, and there are no wrong answers. We appreciate your honest feedback as it helps us improve the system to better meet your needs. + - type: textarea + id: user-persona + attributes: + label: User Persona + description: | + Who is the user? Here is an example: + - Name: John Doe + - Age: 32 + - Occupation: Dirac Developer + - Goals: + 1. Ease eye strain during long working hours by utilizing a dark mode feature. + 2. Improve focus and productivity by reducing glare and distraction from a bright screen. + 3. Maintain a sleek and modern user interface. + - Pain points: + 1. Current bright/light theme of the web app causes eye fatigue, especially when working late into the night. + 2. The lack of a dark mode feature feels outdated and not in alignment with contemporary design standards. + 3. Concerned that continued use of the app in its current state may adversely affect my vision over time. + value: | + - Name: + - Age: + - Occupation: + - Goals: + - Pain points: + validations: + required: true + - type: textarea + id: user-story + attributes: + label: User Story + description: | + What does the user want to achieve in this scenario? Here is an example: + As a developer, John wants a dark mode feature in the web app so that he can work comfortably during late hours and reduce eye strain, while also enjoying a modern and sleek user interface. + value: | + As a [type of user], [User] wants [an action] so that [a benefit/a goal]. + validations: + required: true + - type: textarea + id: additional-comments + attributes: + label: Additional Comments or Suggestions + description: "Share any other feedback, ideas, or suggestions that can help us understand your needs better." + validations: + required: false diff --git a/README.md b/README.md index f4da3c4c..ed8a8435 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,41 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +![Basic tests](https://github.com/DIRACGrid/diracx-web/actions/workflows/basic.yml/badge.svg?branch=main) +![Basic tests](https://github.com/DIRACGrid/diracx-web/actions/workflows/test.yml/badge.svg?branch=main) +![Basic tests](https://github.com/DIRACGrid/diracx-web/actions/workflows/containerised.yml/badge.svg?branch=main) -## Getting Started +# DiracX-Web Prototype -First, run the development server: +## Getting started + +This will allow you to run a demo setup. + +The code changes will be reflected in the demo. + +Requirement: docker, internet ```bash -npm run dev -# or -yarn dev -# or -pnpm dev +# Clone the diracx repository +git clone git@github.com:DIRACGrid/diracx.git + +# Clone the diracx-web repository +git clone git@github.com:DIRACGrid/diracx-web.git + +# Clone the diracx-chart repository +git clone git@github.com:DIRACGrid/diracx-charts.git + +# Run the demo +diracx-charts/run_demo.sh diracx/ diracx-web/ ``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +Open [http://localhost:8000](http://localhost:8000) with your browser to see the result. -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +## Contributing -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +- Want to make a general feedback about the [DIRAC web application](https://github.com/DIRACGrid/WebAppDIRAC)? + Answer to the [Survey](https://github.com/DIRACGrid/diracx-web/discussions/categories/surveys) by creating a new discussion. +- Want to request a feature? + Create a [User Story](https://github.com/DIRACGrid/diracx-web/discussions/categories/user-personas-and-stories) to describe your need. +- Want to discuss about UX/UI design? + Share your [design idea](https://github.com/DIRACGrid/diracx-web/discussions/categories/design-ideas). ## Learn More @@ -24,11 +43,3 @@ To learn more about Next.js, take a look at the following resources: - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.