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

Merged
merged 99 commits into from
Jan 9, 2025
Merged

Feat/otter training #2551

merged 99 commits into from
Jan 9, 2025

Conversation

cpaulve-1A
Copy link
Contributor

@cpaulve-1A cpaulve-1A commented Dec 4, 2024 •
edited
Loading

Proposed change

Design a training solution integrated in the showcase based on webcontainers.
Implement the SDK training.

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 -->
@nx-cloud Nx Cloud
Copy link

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

View your CI Pipeline Execution ↗ for commit 8b1f644.

Command Status Duration Result
nx run-many --target=build --projects=eslint-pl... ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2025-01-09 10:34:19 UTC

@cpaulve-1A cpaulve-1A removed the bug Something isn't working label Dec 19, 2024
cpaulve-1A and others added 5 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 -->
@cpaulve-1A
Merge remote-tracking branch 'origin/main' into merge-main-to-otter-t…
c1217e2 
…raining
@cpaulve-1A
chore: yarn.lock update following merge of main
c86a9f6
@cpaulve-1A
Merge main to otter training (#2667)
994eea7 
## Proposed change
### Conflicting files
.vscode/settings.json
.yarnrc.yml
package.json
packages/@ama-sdk/schematics/package.json
packages/@o3r/core/package.json
packages/@o3r/eslint-config-otter/package.json
yarn.lock 

## Related issues

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- * :octocat: Pull Request #issue -->
@github-actions github-actions bot added the bug Something isn't working label Jan 6, 2025
@codecov Codecov
Copy link

codecov bot commented Jan 6, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 61.86441% with 180 lines in your changes missing coverage. Please review.

Project coverage is 65.91%. Comparing base (48e6670) to head (8b1f644).
Report is 152 commits behind head on main.

✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
...ing/code-editor-view/code-editor-view.component.ts 47.33% 88 Missing and 1 partial ⚠️
...case/src/components/training/training.component.ts 40.29% 38 Missing and 2 partials ⚠️
...e/src/services/webcontainer/webcontainer-runner.ts 46.34% 20 Missing and 2 partials ⚠️
.../src/services/webcontainer/webcontainer.service.ts 26.66% 21 Missing and 1 partial ⚠️
...case/src/helpers/monaco-tree/monaco-tree.helper.ts 72.72% 2 Missing and 1 partial ⚠️
...de-editor-control/code-editor-control.component.ts 91.30% 2 Missing ⚠️
...-editor-terminal/code-editor-terminal.component.ts 95.83% 1 Missing ⚠️
...ps/showcase/testing/mocks/webcontainer-api.mock.ts 90.00% 1 Missing ⚠️
Additional details and impacted files

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

cpaulve-1A and others added 4 commits January 8, 2025 16:49
@cpaulve-1A
chore: add unit test on otter training helpers
4565659
@cpaulve-1A
chore: add unit test on otter training helpers (#2672)
6905db3 
## 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 -->
@cpaulve-1A
feat(training): set solution as readonly
8122ec8 
If enabled, show terminal but deactivate code edition for exercise solutions

Set input as signal on training step
@cpaulve-1A
fneat(training): set solution as readonly (#2679)
8b1f644 
## Proposed change

If enabled, show terminal but deactivate code edition for exercise
solutions

Set input as signal on training step

## 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 cpaulve-1A removed the bug Something isn't working label Jan 9, 2025
@github-actions github-actions bot added the bug Something isn't working label Jan 9, 2025
@cpaulve-1A cpaulve-1A removed the bug Something isn't working label Jan 9, 2025
@cpaulve-1A cpaulve-1A added this pull request to the merge queue Jan 9, 2025
Merged via the queue into main with commit d45970e Jan 9, 2025
35 of 37 checks passed
@cpaulve-1A cpaulve-1A deleted the feat/otter-training branch January 9, 2025 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fpaul-1A fpaul-1A fpaul-1A approved these changes

@matthieu-crouzet matthieu-crouzet matthieu-crouzet approved these changes

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 @matthieu-crouzet @fpaul-1A @sdo-1A