Skip to content

Conversation

@kartben
Copy link
Contributor

@kartben kartben commented Oct 18, 2024

Examples of the PR applied to some boards:

image

Kind of a big PR, but it's split in commits per vendor -- as some of the documentation pages (ex. samples) that now reference boards using the new :zephyr:board: directive sometimes mention multiple boards on the same line, this would lead to many conflicts based on the order in which PR are merged if I am to split the changes in multiple PRs.

There are still quite a few boards/vendors to migrate over but thought I would get the ball rolling :)

Some of the documentation pages that haven't been migrated yet are typically:

When it comes to deciding whether the main image in a board documentation page should be removed to only appear in the new "card", the thought process has been that whenever the image really only was there for illustration purposes, it's been removed (ex. https://builds.zephyrproject.io/zephyr/pr/80048/docs/boards/m5stack/m5stack_atoms3/doc/index.html) but when it is part of a narrative where being able to see the image right next to the text mentioning it, it's been preserved (but also appears in the card); ex. https://builds.zephyrproject.io/zephyr/pr/80048/docs/boards/particle/nrf51_blenano/doc/index.html#connections-and-ios

@kartben kartben force-pushed the migrate_all_boards_to_directive branch 18 times, most recently from 5c51944 to 251d0a7 Compare October 21, 2024 07:51
@kartben kartben force-pushed the migrate_all_boards_to_directive branch 7 times, most recently from 5c5965b to 80e771c Compare October 22, 2024 12:20
@kartben kartben changed the title doc: boards: Migrate (almost?) all boards to new zephyr:board directive/role doc: boards: Migrate (many) boards to new zephyr:board directive/role Oct 22, 2024
@kartben kartben changed the title doc: boards: Migrate (many) boards to new zephyr:board directive/role doc: boards: Migrate -many- boards to new zephyr:board directive/role Oct 22, 2024
@kartben kartben marked this pull request as ready for review October 22, 2024 13:55
@kartben kartben requested a review from nandojve as a code owner October 22, 2024 13:55
This updates the documentation of all the Gaisler boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Khadas boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Ronoth boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Firefly boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Qorvo boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the SECO boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Space Cubics boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the DPTechnics boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Rasperry Pi boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Contextual Electronics boards
to use the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the "others" boards
to use the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the WeAct boards
to use the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Qemu boards
to use the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the CThings boards
to use the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Franzininho boards
to use the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Cadence boards
to use the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Element14 boards
to use the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the SiFive boards
to use the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <[email protected]>
@kartben kartben force-pushed the migrate_all_boards_to_directive branch from 7968c79 to 4a1a2b7 Compare October 24, 2024 07:46
@kartben
Copy link
Contributor Author

kartben commented Oct 24, 2024

  • Rebased to resolve conflicts
  • Updated the beagleboard commit to ensure the new BeagleBone AI-64 is covered

@kartben kartben requested a review from pdgendt October 24, 2024 08:19
@nandojve
Copy link
Member

Hi @kartben ,

No image from Atmel / GD should be removed. They are images from the development kit and should be kept.

@kartben
Copy link
Contributor Author

kartben commented Oct 24, 2024

Hi @kartben ,

No image from Atmel / GD should be removed. They are images from the development kit and should be kept.

@nandojve
Can you elaborate? The images are still there, only they're showing in the "side card" now.
https://builds.zephyrproject.io/zephyr/pr/80048/docs/boards/gd/gd32a503v_eval/doc/index.html

@nandojve
Copy link
Member

Hi @kartben ,
No image from Atmel / GD should be removed. They are images from the development kit and should be kept.

@nandojve Can you elaborate? The images are still there, only they're showing in the "side card" now. https://builds.zephyrproject.io/zephyr/pr/80048/docs/boards/gd/gd32a503v_eval/doc/index.html

I understood now. The below don't affect the the outcome.

-.. image:: img/gd32a503v_eval.jpg
-     :align: center
-     :alt: gd32a503v_eval

Sorry about the noise.

@kartben
Copy link
Contributor Author

kartben commented Oct 24, 2024

Sorry about the noise.

That's no problem at all, really! I understand how the change can be confusing at first sight so no worries :)
For others wondering the same, this is something I have tried to explain in the initial comment in this PR ("When it comes to deciding whether the main image in a board documentation page [...]).

Copy link
Contributor

@pdgendt pdgendt left a comment

Choose a reason for hiding this comment

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

Nice work!

@carlescufi carlescufi merged commit a4adfc7 into zephyrproject-rtos:main Oct 24, 2024
19 checks passed
@kartben kartben deleted the migrate_all_boards_to_directive branch October 24, 2024 15:53
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.

6 participants