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.

Sign up for GitHub

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

Jump to bottom

front: add lmr help module #9983

Merged
merged 1 commit into from
Dec 12, 2024
Merged

front: add lmr help module #9983

merged 1 commit into from
Dec 12, 2024

Conversation

Math-R
Copy link
Contributor

@Math-R Math-R commented Dec 7, 2024 •
edited
Loading

close #9570

To test it, navigate through LMR application and then click on the "Aide" button on the top right corner of the screen

maquette

@Math-R Math-R requested a review from a team as a code owner December 7, 2024 23:09
@Math-R Math-R force-pushed the mrd/front/lmr-help-section branch 3 times, most recently from 557dc98 to 32ce707 Compare December 8, 2024 19:10
@github-actions github-actions bot added the area:front Work on Standard OSRD Interface modules label Dec 8, 2024
@codecov-commenter
Copy link

codecov-commenter commented Dec 8, 2024 •
edited
Loading

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 98.65471% with 3 lines in your changes missing coverage. Please review.

Project coverage is 80.08%. Comparing base (fe3b339) to head (caaf4b5).
Report is 1 commits behind head on dev.

Files with missing lines Patch % Lines
front/scripts/i18n-checker.ts 0.00% 2 Missing ⚠️
...ications/stdcm/components/StdcmHelpModule/types.ts 50.00% 1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files 
@@            Coverage Diff             @@
##              dev    #9983      +/-   ##
==========================================
+ Coverage   80.06%   80.08%   +0.01%     
==========================================
  Files        1050     1054       +4     
  Lines      105431   105648     +217     
  Branches      758      759       +1     
==========================================
+ Hits        84418    84612     +194     
- Misses      20972    20995      +23     
  Partials       41       41
Flag Coverage Δ
editoast 74.20% <ø> (-0.07%) ⬇️
front 89.28% <98.65%> (+0.03%) ⬆️
gateway 2.18% <ø> (ø)
osrdyne 3.28% <ø> (ø)
railjson_generator 87.50% <ø> (ø)
tests 87.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Math-R Math-R force-pushed the mrd/front/lmr-help-section branch 2 times, most recently from 560e6c6 to 5190c87 Compare December 9, 2024 09:18
@Math-R Math-R marked this pull request as draft December 9, 2024 09:31
Uriel-Sautron
Uriel-Sautron approved these changes Dec 9, 2024
View reviewed changes
Copy link
Contributor

@Uriel-Sautron Uriel-Sautron left a comment

Choose a reason for hiding this comment

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

Nice job !!! Tested, pleasant and smooth behavior.
I have left some comments.

front/src/applications/stdcm/components/StdcmHelpModule/StdcmHelpModule.tsx Outdated Show resolved Hide resolved
front/src/applications/stdcm/views/StdcmView.tsx Show resolved Hide resolved
@Uriel-Sautron Uriel-Sautron self-requested a review December 9, 2024 14:01
@Math-R Math-R marked this pull request as ready for review December 9, 2024 14:21
@Math-R Math-R force-pushed the mrd/front/lmr-help-section branch from 89c7b57 to 310b6eb Compare December 9, 2024 14:33
Uriel-Sautron
Uriel-Sautron approved these changes Dec 9, 2024
View reviewed changes
Copy link
Contributor

@Uriel-Sautron Uriel-Sautron left a comment

Choose a reason for hiding this comment

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

LGTM !!!

@emersion
Copy link
Member

In the mockup, there is a paragraph below the main "Help" heading:

out

Is the mockup outdated, or is the paragraph missing?

emersion
emersion reviewed Dec 10, 2024
View reviewed changes
Copy link
Member

@emersion emersion left a comment

Choose a reason for hiding this comment

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

Nice! Here are a few comments.

The result doesn't exactly look like the mockup, e.g. some margins are a bit different. However that simplifies the code so I'm inclined to just ignore these differences.

front/src/styles/scss/applications/stdcm/_helpModule.scss Outdated Show resolved Hide resolved
front/src/styles/scss/applications/stdcm/_helpModule.scss Outdated Show resolved Hide resolved
front/src/applications/stdcm/views/StdcmView.tsx Outdated Show resolved Hide resolved
front/src/applications/stdcm/components/StdcmHelpModule/types.ts Outdated Show resolved Hide resolved
front/src/applications/stdcm/components/StdcmHelpModule/SectionContentManager.tsx Outdated Show resolved Hide resolved
front/src/applications/stdcm/components/StdcmHelpModule/SectionContentManager.tsx Show resolved Hide resolved
front/src/applications/stdcm/components/StdcmHelpModule/SectionContentManager.tsx Outdated Show resolved Hide resolved
front/src/applications/stdcm/components/StdcmHelpModule/SectionContentManager.tsx Outdated Show resolved Hide resolved
front/public/locales/en/stdcm-help-section.json Outdated Show resolved Hide resolved
front/src/applications/stdcm/components/StdcmHelpModule/types.ts Outdated Show resolved Hide resolved
@Math-R
Copy link
Contributor Author

Math-R commented Dec 10, 2024

In the mockup, there is a paragraph below the main "Help" heading:

out

Is the mockup outdated, or is the paragraph missing?

The mockup is outdated, @axrolld asks me to not put this paragraph

@Math-R Math-R force-pushed the mrd/front/lmr-help-section branch from 310b6eb to 9b0782a Compare December 12, 2024 10:19
@Math-R Math-R force-pushed the mrd/front/lmr-help-section branch 8 times, most recently from d4066fa to a8a8adf Compare December 12, 2024 13:34
SharglutDev
SharglutDev approved these changes Dec 12, 2024
View reviewed changes
Copy link
Contributor

@SharglutDev SharglutDev left a comment

Choose a reason for hiding this comment

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

Lgtm and tested, good work !

@Math-R Math-R force-pushed the mrd/front/lmr-help-section branch 2 times, most recently from 50c9400 to a7ce1c9 Compare December 12, 2024 14:19
@Math-R Math-R enabled auto-merge December 12, 2024 14:20
@Math-R Math-R disabled auto-merge December 12, 2024 14:20
@Math-R Math-R enabled auto-merge December 12, 2024 14:24
@Math-R Math-R disabled auto-merge December 12, 2024 14:35
@Math-R
front: add help module for lmr usage
caaf4b5 
Signed-off-by: Math_R_ <mathieu.richard747@gmail.com>

front: add asu support in lmr's help module

Signed-off-by: Math_R_ <mathieu.richard747@gmail.com>

front: add english translation fot lmr help section

Signed-off-by: Math_R_ <mathieu.richard747@gmail.com>
@Math-R Math-R force-pushed the mrd/front/lmr-help-section branch from a7ce1c9 to caaf4b5 Compare December 12, 2024 15:21
@Math-R Math-R enabled auto-merge December 12, 2024 15:21
@Math-R Math-R added this pull request to the merge queue Dec 12, 2024
Merged via the queue into dev with commit 29b4005 Dec 12, 2024
27 checks passed
@Math-R Math-R deleted the mrd/front/lmr-help-section branch December 12, 2024 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SharglutDev SharglutDev SharglutDev approved these changes

@SarahBellaha SarahBellaha Awaiting requested review from SarahBellaha

@emersion emersion Awaiting requested review from emersion

@Uriel-Sautron Uriel-Sautron Awaiting requested review from Uriel-Sautron

Assignees
No one assigned
Labels
area:front Work on Standard OSRD Interface modules
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Implement help component in last minute request app
5 participants
@Math-R @codecov-commenter @emersion @Uriel-Sautron @SharglutDev