Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/onboarding #377

Merged
merged 194 commits into from
Sep 6, 2024
Merged

Feature/onboarding #377

merged 194 commits into from
Sep 6, 2024

Conversation

emilijadunoska
Copy link
Contributor

@emilijadunoska emilijadunoska commented Aug 2, 2024

Description

This PR is for the development of the Onboarding System for ESID that effectively guides new users through the application's features and helps them become familiar with it.

Related Issues

Design Decisions

The onboarding system is developed with the React joyride library. There is also a welcome modal that is displayed during the user's initial visit which provides an overview of the application through a series of informative slides and illustrations. The onboarding tours are accessible through the information button in the top bar, which makes them available without being intrusive. Users have the flexibility to start, pause, or retake any tour at their own pace. This implementation makes the onboarding experience adaptable for both new and existing users.

Possible alternative implementations were considered, such as creating a one-time static tour that users would go through only during their first visit. However, this approach is less flexible and doesn't allow users to revisit the tours later or learn at their own pace.

Performance & Quality

Checklist

I, the author of this PR checked the following requirements for good software quality:

  • The code is properly formatted (I ran the formatter)
  • The code is written with our software quality standards (I ran the linter)
  • The code is written using our code style
  • Extensive in source documentation has been added
  • Unit and/or integration tests have been added
  • All texts have been internationalized with at least the following languages:
    • English
    • German
  • I tried addressing all new accessibility problems displayed in the console and documented if they can't be fixed
  • I attached performance measurements to prevent performance degradation
  • I added the changes to the next release section of the changelog

I, the reviewer checked the following things:

  • I ran the software once and tried all new and related functionality to this PR
  • I looked at all new and changed lines of code and commented on possible problems
  • I read the added documentation and checked if it is understandable and clear
  • I checked the added tests for completeness
  • I checked the internationalized strings for spelling errors
  • I checked the performance metrics for problems or unexplained degradation
  • I checked that the changes are noted in the changelog

Violini and others added 30 commits May 29, 2024 14:28
…docs and fix major bug and also add the possibility to decide how many lines to show in the card when are folded and when are expanded
… major bug and also add the possibility to decide how many lines to show in the card when are folded and when are expanded
…olor not reflecting currently selected scenario after tour is finished
@emilijadunoska emilijadunoska marked this pull request as ready for review August 29, 2024 15:08
@emilijadunoska emilijadunoska self-assigned this Sep 2, 2024
@emilijadunoska emilijadunoska added the Epic:Onboarding Issues that are part of the user onboarding label Sep 2, 2024
Copy link
Collaborator

@JonasGilg JonasGilg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very good. The code quality is very high.

Apart from the comments and suggestions I already made the only other change request would be to suggest, for you to write all comments with a capital letter at the start and if they form a sentence also with a period at the end.

frontend/.env.template Outdated Show resolved Hide resolved
frontend/docs/changelog/changelog-de.md Outdated Show resolved Hide resolved
@emilijadunoska
Copy link
Contributor Author

Looks very good. The code quality is very high.

Apart from the comments and suggestions I already made the only other change request would be to suggest, for you to write all comments with a capital letter at the start and if they form a sentence also with a period at the end.

Thank you for the positive feedback! I've addressed the comments and suggestions you made.

@emilijadunoska emilijadunoska merged commit 7336aef into develop Sep 6, 2024
8 checks passed
@emilijadunoska emilijadunoska deleted the feature/onboarding branch September 6, 2024 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic:Onboarding Issues that are part of the user onboarding
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[EPIC]: User Onboarding
2 participants