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

Updating UKIT009 #370

Merged
merged 11 commits into from
Nov 19, 2024
Merged

Conversation

martinaxgloria
Copy link
Member

@martinaxgloria martinaxgloria commented Nov 13, 2024

This PR contains:

  • @MeliTaliani commit with MKIT009 update;
  • the refactor of the post-flashing operations after jetpack installation: now, this information is stored in the dedicated pages, so the Jetpack installation page is shorter and clearer now
  • the procedure to setup the Orin NX to be used with FRAMOS-IMX415 cameras

What is missing:

  • software instruction about the UKIT009 update
  • review of the kinematics of the new UKIT009

I'll keep the PR in draft until the previous points are addressed.

For the time being, I generated the documentation on my fork to see the output:

cc @Nicogene @pattacini

@martinaxgloria martinaxgloria marked this pull request as ready for review November 13, 2024 15:48
@martinaxgloria
Copy link
Member Author

I don't know if it is the cause of the CI failure, but I'm using a link whose target is not already present in the documentation (i.e. I wrote that in iKin the new iCub version will be available since release v2024.11.0 with the reference to the markdown that not exist yet). When I do mkdocs serve to build the page locally, I retrieved only a warning and the page is built anyway.

@martinaxgloria
Copy link
Member Author

I removed the reference to the page that doesn't exist yet and I will add that once we have the release v2024.11.0

@pattacini
Copy link
Member

Thanks heaps for the contributions!
I'll be reviewing the PR in the next few days.

@pattacini pattacini requested a review from Copilot November 16, 2024 10:58

Choose a reason for hiding this comment

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

Copilot reviewed 9 out of 14 changed files in this pull request and generated no suggestions.

Files not reviewed (5)
  • docs/upgrade_kits/head_4k/support.md: Evaluated as low risk
  • mkdocs.yml: Evaluated as low risk
  • docs/icub_versions/index.md: Evaluated as low risk
  • docs/icub_operating_systems/icubos/jetpack.md: Evaluated as low risk
  • docs/icub_operating_systems/icubos/install-cmake.md: Evaluated as low risk
Copy link
Member

@pattacini pattacini left a comment

Choose a reason for hiding this comment

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

Hi @martinaxgloria

Well done so far but I reckon we have to streamline a bit this PR, especially in terms of number of pages for the post-flashing procedure.

Also, we have to fix these warnings:

INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
             - icub_operating_systems/icubos/create-backup-image.md
INFO    -  Doc file 'icub_operating_systems/icubos/create-backup-image.md' contains a link '#jetpack-setup-on-the-host', but there is no such anchor on this page.
INFO    -  Doc file 'icub_operating_systems/icubos/create-backup-image.md' contains a link '#booting-the-nvidia-jetson-board-in-recovery-mode', but there is no such anchor on this page.

docs/icub_operating_systems/icubos/install-cmake.md Outdated Show resolved Hide resolved
docs/icub_operating_systems/icubos/jetpack.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
@martinaxgloria
Copy link
Member Author

Hi @pattacini, thanks for the review!
About:

Ubuntu 18.04 is far away in the past and I guess we no longer need to address it.

That said, it could be still convenient to keep this info about installing the latest CMake wrt the version shipped with a specific Ubuntu distro.

If this is the case, then I would only rephrase the intro saying when these instructions may apply and why.

you're right, I kept this info since, if I remember well, the Xavier NX is Ubuntu 18.04 based yet. But this board will become outdated with the UKIT009 update, so we could think about removing it from the documentation and refactoring the CMake installation instructions depending on the OS version.

About the number of pages for the post-flashing operations, instead, talking with @Nicogene we agreed that the Jetpack installation page was too long and that it'll be better to remove the post-flashing operations from that page and re-organize this section into small dedicated pages. Tomorrow or in the next few days we can align f2f on that

@pattacini
Copy link
Member

pattacini commented Nov 17, 2024

About the number of pages for the post-flashing operations, instead, talking with @Nicogene we agreed that the Jetpack installation page was too long and that it'll be better to remove the post-flashing operations from that page and re-organize this section into small dedicated pages. Tomorrow or in the next few days we can align f2f on that

Disagree with that 😉

  • Honestly, I don't like the final rendering that is split into so many pages.
  • Also, an intro page for the post-flashing is missing, which is, I think, the only page we may refer in the navigation section.

Let's meet up for it.

@martinaxgloria
Copy link
Member Author

In 33e7dc7 I applied the suggested changes after the f2f chat we had yesterday (cc @Nicogene @pattacini). In particular, I:

  • created an introduction page for the post-flashing operations with a table of context in which are listed the available optional procedures (I removed the "optional" from the title of each page)
  • removed from the navigation tree those pages and I added only the introduction page for both iCub and ergoCub installation
  • added an admonition with a reference to the jetpack installation page: in this way, each page can self-exists
  • removed the procedures for the creation of the backup image (not working) and cmake installation for Ubuntu 18.04 (not needed)

@martinaxgloria
Copy link
Member Author

I regenerated the pages if you want to see the output now

Copy link
Member

@pattacini pattacini left a comment

Choose a reason for hiding this comment

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

Please, consider these further notes.

docs/icub_operating_systems/icubos/jetpack.md Outdated Show resolved Hide resolved
docs/icub_versions/index.md Outdated Show resolved Hide resolved
@martinaxgloria
Copy link
Member Author

martinaxgloria commented Nov 19, 2024

Hi @pattacini,

here 40ff57e you can find the changes you suggested. I added the CMake installation instructions again but for Ubuntu 20.04 since it is required for yarp v3.10.0 and we had to follow this procedure on the laptop of iCubGenova11 which has Ubuntu 20.04 yet (cc @Nicogene)

Please, let me know if it's ok now, thanks!

Copy link
Member

@pattacini pattacini left a comment

Choose a reason for hiding this comment

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

Thanks heaps!
Merging.

@pattacini pattacini merged commit 11de72b into icub-tech-iit:master Nov 19, 2024
1 check passed
@martinaxgloria martinaxgloria deleted the feat/ukit009_doc branch November 19, 2024 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants