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

Feat/otter training #2551

Open
wants to merge 92 commits into
base: main
Choose a base branch
from
Open

Feat/otter training #2551

wants to merge 92 commits into from

Conversation

cpaulve-1A
Copy link
Contributor

Proposed change

Related issues

- No issue associated -

sdo-1A and others added 30 commits October 2, 2024 11:53
@sdo-1A
feat: otter training - components
63b5bc1
@sdo-1A
feat: otter training - components (#2173)
9a62adb 
## Proposed change

Creation of components that will be used in the Otter training (such as
a code editor, etc)

## Related issues

- 🐛 Fixes #(issue)
- 🚀 Feature #(issue)

<!-- Please make sure to follow the contributing guidelines on
https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md -->
@sdo-1A
feat: otter training - prepare training content
c36820a
@sdo-1A
feat: otter training - prepare training content (#2223)
992f1ff 
## Proposed change

Preparation for the training content

## Related issues

- 🐛 Fixes #(issue)
- 🚀 Feature #(issue)

<!-- Please make sure to follow the contributing guidelines on
https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md -->
@sdo-1A
feat: otter training - training sdk
f78569f
@sdo-1A
feat: otter training - training sdk (#2267)
e81546d 
## Proposed change

Creation of training SDK
This PR is mainly to check the package files, the specifications are
likely to change when we update the content of the SDK training
exercises.

## Related issues

- 🐛 Fixes #(issue)
- 🚀 Feature #(issue)

<!-- Please make sure to follow the contributing guidelines on
https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md -->
@fpaul-1A
feat(training): add load indicator on output
53be8c0
@sdo-1A
feat: coi-serviceworker to deploy training in GitHub pages
c973c89
@sdo-1A
feat: coi-serviceworker to deploy training in GitHub pages (#2317)
36e5eb3 
## Proposed change

Cross-origin isolation service worker in order to be able to deploy the
training on GitHub pages.
Source of this script:
https://github.com/gzuidhof/coi-serviceworker/tree/master

## Related issues

- 🐛 Fixes #(issue)
- 🚀 Feature #(issue)

<!-- Please make sure to follow the contributing guidelines on
https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md -->
@fpaul-1A
feat(training): add load indicator on output (#2307)
988805b 
## Proposed change

Add an indicator on the terminal output to know that some work is in
progress

![image](https://github.com/user-attachments/assets/5ec89ad1-859c-4db1-81c4-70998457d2e4)

Working example: https://fpaul-1a.github.io/otter/#/sdk-training#4

## Related issues

- 🐛 Fixes #(issue)
- 🚀 Feature #(issue)

<!-- Please make sure to follow the contributing guidelines on
https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md -->
@sdo-1A
feat: otter sdk training - sdk with date generation and usage
88cb842
@sdo-1A
feat: otter sdk training - sdk with date generation and usage (#2332)
2cb7487 
## Proposed change

Otter SDK Training - SDK with Dates - Generation step and How to use
step

NOTE: the app.component files are those that are added to the
webcontainer (these are converted to a JSON format and then added to the
webcontainer for the exercises)



Generation step:

![image](https://github.com/user-attachments/assets/e74aa0ab-aa9d-4846-af76-928ef1298b33)

![image](https://github.com/user-attachments/assets/d1cf75c4-a17d-431c-a8a8-6122532e6513)
Show solution:

![image](https://github.com/user-attachments/assets/ee6a6f93-62cf-4cf0-9ae2-aee5b317043b)

How to use:

![image](https://github.com/user-attachments/assets/93401778-b55a-4533-96d0-5c4d353a11d1)

![image](https://github.com/user-attachments/assets/37a60396-af3e-4e61-92b8-21f18caa0f9f)
Show solution:

![image](https://github.com/user-attachments/assets/c6bdbf47-3a90-45a8-b96e-8e4eaa17f21d)

## Related issues

- 🐛 Fixes #(issue)
- 🚀 Feature #(issue)

<!-- Please make sure to follow the contributing guidelines on
https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md -->
@fpaul-1A
feat(training): update css of the showcase to reduce the unused space…
372b38c 
… on screen
@fpaul-1A
feat(training): update css of the showcase to reduce the unused space…
d86e107 
… on screen (#2433)

## Proposed change

https://fpaul-1a.github.io/otter/#/sdk-training#0
https://fpaul-1a.github.io/otter/#/sdk-training#4


![image](https://github.com/user-attachments/assets/fadd94bd-6558-426e-8dc8-687c3233a8de)


## Related issues

<!--
Please make sure to follow the [contribution
guidelines](https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md)
-->

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- * :octocat: Pull Request #issue -->
@fpaul-1A
feat(training): use markdown for step instructions
cd14d79
@fpaul-1A
feat(training): use markdown for step instructions (#2414)
0a0cc4d 
## Proposed change

Instead of writing the trainings instructions in HTML, we can use
markdown.
With this, we can easily enable the code highlighting.

Example:
https://fpaul-1a.github.io/otter/#/sdk-training#2
Generated from
https://github.com/fpaul-1A/otter/blob/main/apps/showcase/src/assets/trainings/sdk/steps/typescript-sdk/instructions.md


![image](https://github.com/user-attachments/assets/de3c26cc-5f32-4a18-9c1b-4d4257b51f00)


## Related issues

<!--
Please make sure to follow the [contribution
guidelines](https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md)
-->

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- * :octocat: Pull Request #issue -->
@fpaul-1A
Merge branch 'main' of https://github.com/AmadeusITGroup/otter into f…
2dea1bb 
…eat/otter-training-rebase
@fpaul-1A
Merge main into otter-training (#2450)
809b3f1 
## Proposed change

<!--
Please include a summary of the changes and the related issue.
Please also include relevant motivation and context.
-->

## Related issues

<!--
Please make sure to follow the [contribution
guidelines](https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md)
-->

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- * :octocat: Pull Request #issue -->
@fpaul-1A
feat(training): resizable areas
74e2336
@fpaul-1A
feat(training): resizable areas (#2454)
7016849 
## Proposed change

https://fpaul-1a.github.io/otter/#/sdk-training#9

## Related issues

<!--
Please make sure to follow the [contribution
guidelines](https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md)
-->

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- * :octocat: Pull Request #issue -->
@fpaul-1A
fix(training): markdown alerts not correctly displayed
d50a168
@fpaul-1A
fix(training): wrong training-tools exports
6931d0b
@fpaul-1A
fix(training): missing files for training-sdk tests
90f4825
@fpaul-1A
fix(training): markdown alerts not correctly displayed (#2463)
2f679ab 
## Proposed change

<!--
Please include a summary of the changes and the related issue.
Please also include relevant motivation and context.
-->

## Related issues

<!--
Please make sure to follow the [contribution
guidelines](https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md)
-->

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- * :octocat: Pull Request #issue -->
@fpaul-1A
fix(training): wrong training-tools exports (#2464)
b277588 
## Proposed change

<!--
Please include a summary of the changes and the related issue.
Please also include relevant motivation and context.
-->

## Related issues

<!--
Please make sure to follow the [contribution
guidelines](https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md)
-->

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- * :octocat: Pull Request #issue -->
@sdo-1A
feat: otter sdk training - introduction step
2383cde
@fpaul-1A
fix(training): missing files for training-sdk tests (#2465)
8b3b9f5 
## Proposed change

<!--
Please include a summary of the changes and the related issue.
Please also include relevant motivation and context.
-->

## Related issues

<!--
Please make sure to follow the [contribution
guidelines](https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md)
-->

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- * :octocat: Pull Request #issue -->
@fpaul-1A
fix(training): accessibility of tabs in code editor controls
e92836c
@fpaul-1A
fix(training): accessibility of tabs in code editor controls (#2468)
7b3c506 
## Proposed change

<!--
Please include a summary of the changes and the related issue.
Please also include relevant motivation and context.
-->

## Related issues

<!--
Please make sure to follow the [contribution
guidelines](https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md)
-->

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- * :octocat: Pull Request #issue -->
@sdo-1A
feat: otter sdk training - introduction step (#2318)
701f1d8 
## Proposed change

Otter SDK Training - Introduction step

## Related issues

- 🐛 Fixes #(issue)
- 🚀 Feature #(issue)

<!-- Please make sure to follow the contributing guidelines on
https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md -->
cpaulve-1A and others added 18 commits December 6, 2024 11:28
@cpaulve-1A
Merge remote-tracking branch 'origin/main' into merge/main-to-training
8cd55ff
@cpaulve-1A
chore: update screenshots
0eb7575
@cpaulve-1A
chore: merge main into training (#2563)
2b3f45f 
## Proposed change
Merge `main` content into the otter training feature branch.

Conflicts:

-
apps/showcase/e2e-playwright/sanity/screenshots/visual-sanity.e2e.ts/chromium/component-replacement.png
-
apps/showcase/e2e-playwright/sanity/screenshots/visual-sanity.e2e.ts/chromium/configuration.png
-
apps/showcase/e2e-playwright/sanity/screenshots/visual-sanity.e2e.ts/chromium/design-token.png
-
apps/showcase/e2e-playwright/sanity/screenshots/visual-sanity.e2e.ts/chromium/dynamic-content.png
-
apps/showcase/e2e-playwright/sanity/screenshots/visual-sanity.e2e.ts/chromium/home.png
-
apps/showcase/e2e-playwright/sanity/screenshots/visual-sanity.e2e.ts/chromium/localization.png
-
apps/showcase/e2e-playwright/sanity/screenshots/visual-sanity.e2e.ts/chromium/placeholder.png
-
apps/showcase/e2e-playwright/sanity/screenshots/visual-sanity.e2e.ts/chromium/rules-engine.png
-
apps/showcase/e2e-playwright/sanity/screenshots/visual-sanity.e2e.ts/chromium/run-app-locally.png
-
apps/showcase/e2e-playwright/sanity/screenshots/visual-sanity.e2e.ts/chromium/sdk-generator.png
- apps/showcase/package.json
- apps/showcase/project.json
- apps/showcase/src/app/app.module.ts
- apps/showcase/src/app/dynamic-content/dynamic-content.component.ts
- apps/showcase/src/app/rules-engine/rules-engine.component.ts
- apps/showcase/src/app/run-app-locally/run-app-locally.component.ts
-
apps/showcase/src/components/utilities/clipboard-button/clipboard-button-pres.component.ts
-
apps/showcase/src/components/utilities/clipboard-button/clipboard-button-pres.template.html
- apps/showcase/src/components/utilities/index.ts
- apps/showcase/src/services/webcontainer/webcontainer-runner.ts
- package.json
- packages/@o3r-training/showcase-sdk/project.json
- yarn.lock
@cpaulve-1A
chore: merge main into otter training
1a4da67
@cpaulve-1A
Merge main to otter training (#2570)
a0f9519 
## Conflicts
- apps/showcase/project.json
@cpaulve-1A
fix: repair build and fix design
6516528
@cpaulve-1A
fix: repair build and fix design (#2572)
503f88f 
## Proposed change

Repair yarn.lock and adapt padding on instructions

*- No issue associated -*
@fpaul-1A
feat(training): file navigation inside code editor
39fdfea
@fpaul-1A
test(training): visual testing for training steps
3977369
@fpaul-1A
feat(training): file navigation inside code editor (#2544)
74e8403 
## Proposed change

Enable `Go to Definition` feature (Ctrl+click), auto complete and avoid
errors on imports.
https://fpaul-1a.github.io/otter/#/sdk-training#1


![image](https://github.com/user-attachments/assets/02527b55-e049-49bd-a586-895001799363)

## Related issues

<!--
Please make sure to follow the [contribution
guidelines](https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md)
-->

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- * :octocat: Pull Request #issue -->
@cpaulve-1A
fix: base code navigation on webcontainer instead of project initial …
22ed14a 
…value

Project only contains the description of the exercise and does not reflect the trainee changes
@cpaulve-1A
fix: base code navigation on webcontainer instead of project initial …
846f229 
…value (#2590)

## Proposed change
Project only contains the description of the exercise and does not
reflect the trainee changes.
The file list should reflect the webcontainer state

Fixes also e2e tests and add a prefix for training directories to avoid
name conflicts

## Related issues

*- No issue associated -*
@fpaul-1A
test(training): visual testing for training steps (#2587)
2e1374e 
## Proposed change

<!--
Please include a summary of the changes and the related issue.
Please also include relevant motivation and context.
-->

## Related issues

<!--
Please make sure to follow the [contribution
guidelines](https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md)
-->

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- * :octocat: Pull Request #issue -->
@matthieu-crouzet
feat(training): persistence of code modifications
94c77f0
@matthieu-crouzet
feat(training): persistence of code modifications (#2579)
7f58289 
## Proposed change
Add persistence in `localStorage` of code modifications in a training
step.
When the user refresh or come back on the training on which code
modifications were made, we prompt a dialog to ask if he wants to keep
the changes or discard them.

![image](https://github.com/user-attachments/assets/b55fccc4-97a8-44b4-be69-2bcebf586e55)


With this feature we think also to add a `Reset` or `Discard changes`
button, it will be done in another PR, unless someone think it's a must
inside this PR.
@cpaulve-1A
chore: merge main branch into otter training
07016d1
@cpaulve-1A
chore: fix build merge main into training
6f662e5
@cpaulve-1A
Merge main to otter training (#2636)
64d5a42 
## Proposed change

Merge main to otter training

### Conflicting files .vscode/settings.json

apps/showcase/package.json
package.json
packages/@o3r-training/showcase-sdk/package.json
packages/@o3r-training/showcase-sdk/project.json
packages/@o3r/core/package.json
packages/@o3r/eslint-config-otter/package.json
yarn.lock

## Related issues

*- No issue associated -*
@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Dec 19, 2024 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 64d5a42.

Command Status Duration Result
nx run-many --target=test-e2e ❌ Failed 9m 51s View ↗
nx affected --target=test --cacheDirectory=D:\a... ❌ Failed 10m 45s View ↗
nx affected --target=test --cacheDirectory=/hom... ❌ Failed 8m 7s View ↗
nx run-many --target=test-int ✅ Succeeded 54m 50s View ↗
nx run-many --target=build --projects=eslint-pl... ✅ Succeeded 1s View ↗
nx run-many --target=publish --nx-bail --userco... ✅ Succeeded 37s View ↗
nx run-many --target=build ✅ Succeeded 16m 53s View ↗
nx affected --target=lint --base=remotes/origin... ✅ Succeeded 15m 5s View ↗
Additional runs (3) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2024-12-19 16:43:05 UTC

@cpaulve-1A cpaulve-1A removed the bug Something isn't working label Dec 19, 2024
cpaulve-1A and others added 2 commits December 20, 2024 14:35
@cpaulve-1A
fix: test and visual testing update for otter training
bfa43cb
@cpaulve-1A
fix: test and visual testing update for otter training (#2638)
ac5d4e7 
## Proposed change

<!--
Please include a summary of the changes and the related issue.
Please also include relevant motivation and context.
-->

## Related issues

<!--
Please make sure to follow the [contribution
guidelines](https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md)
-->

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- * :octocat: Pull Request #issue -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
enhancement New feature or request project:@ama-sdk/core project:new-version-gh-action project:@o3r/showcase project:@o3r-training/showcase-sdk project:@o3r-training/training-sdk project:@o3r-training/training-tools
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@cpaulve-1A @sdo-1A @fpaul-1A @matthieu-crouzet