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

feat: otter training - prepare training content #2223

Merged
merged 1 commit into from
Oct 9, 2024

Conversation

sdo-1A
Copy link
Contributor

@sdo-1A sdo-1A commented Oct 2, 2024

Proposed change

Preparation for the training content

Related issues

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

@sdo-1A sdo-1A requested a review from a team as a code owner October 2, 2024 15:44
Copy link

nx-cloud bot commented Oct 2, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit c36820a. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@github-actions github-actions bot added enhancement New feature or request project:@o3r/showcase labels Oct 2, 2024
void this.loadSteps();
}

public async loadResource(url: string) {
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to put more tsdoc on this file

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated, let me know if it is not clear enough

{
label: 'Training',
links: [
{ url: '/sdk-training', label: 'SDK Training' }
Copy link
Contributor

@matthieu-crouzet matthieu-crouzet Oct 2, 2024

Choose a reason for hiding this comment

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

To be discussed with the team but shouldn't we review that hierarchy to have something like

Topic
  |_ What is it?
  |_ How to?
  |_ Training
  |_ Next steps

instead of having all the trainings in the same group

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's do it in another PR?

Copy link
Contributor

Choose a reason for hiding this comment

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

yes sure
it's just to add the topic for our next discussion

}
const sanitizedPath = resource.path.replace(new RegExp('^[.]/?'), '');
const parsedPath = sanitizedPath.split('/');
parsedPath.reduce((pointer, path, index) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

let's try to see if we ca replace that with jsonPath.apply?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

(future PR)

/**
* Index of the training step to display
*/
public currentStepIndex = 0;
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not using signal for these variables used in the template ?

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we really need it?

Copy link
Contributor

Choose a reason for hiding this comment

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

It was just a question for consistency I do not have strong opinion on that :)

nx.json Outdated Show resolved Hide resolved
@@ -55,7 +55,7 @@
"{projectRoot}/dev-resources",
"{projectRoot}/training-assets",
"{projectRoot}/*.metadata.json",
"packages/@o3r/training-sdk/dist/*-structure.json"
"{workspaceRoot}/packages/@o3r/training-sdk/dist/*-structure.json"
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure it is a good idea to add a file from another page as input.
The best practice is to add the task, from @o3r/training-sdk, resulting to these json files in dependOn with the ^ prefix.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated (this will be more clear when we open the PR for with the package @o3r/training-sdk --> I can remove this modification in the current PR and add it to the next one if you prefer)

apps/showcase/scripts/prepare-training-exercises/index.cjs Outdated Show resolved Hide resolved
apps/showcase/scripts/prepare-training-exercises/index.cjs Outdated Show resolved Hide resolved
@sdo-1A sdo-1A merged commit 992f1ff into feat/otter-training Oct 9, 2024
2 checks passed
@sdo-1A sdo-1A deleted the feat/training-sdk branch October 9, 2024 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants