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

Re-organize board-specific samples per vendor and add zephyr:code-sample directive #78089

Merged
merged 22 commits into from
Sep 13, 2024

Conversation

kartben
Copy link
Collaborator

@kartben kartben commented Sep 6, 2024

  • Added missing .. zephyr:code-sample:: directives
  • Grouped samples by vendor
  • Added intermediate table of contents to get rid of the very flat/messy top level ToC we had

Note 1: The size of the change set is impressive, but it really is mostly just moving files around while adding proper HTML redirects when necessary. Splitting this into multiple PRs would lead to mostly systematic merge conflicts in the redirects.py file.

Note 2: samples/boards/arc_secure_services probably needs a better home as it's not clear it's a "board" sample. I have left it out from the PR and this is the only remaining "non-vendor" top-level folder underneath samples/boards.

BEFORE: https://docs.zephyrproject.org/latest/samples/boards/boards.html
AFTER: https://builds.zephyrproject.io/zephyr/pr/78089/docs/samples/boards/boards.html

@kartben kartben force-pushed the boards_samples_cleanup branch 8 times, most recently from 8ef8cc1 to 88533e3 Compare September 6, 2024 13:49
@kartben kartben changed the title Restructure board-specific samples Re-organize board-specific samples per vendor Sep 6, 2024
@kartben kartben force-pushed the boards_samples_cleanup branch 12 times, most recently from 88710de to 351220b Compare September 8, 2024 07:34
@kartben kartben changed the title Re-organize board-specific samples per vendor Re-organize board-specific samples per vendor and and zephyr:code-sample directive Sep 8, 2024
@kartben kartben changed the title Re-organize board-specific samples per vendor and and zephyr:code-sample directive Re-organize board-specific samples per vendor and add zephyr:code-sample directive Sep 8, 2024
@kartben kartben force-pushed the boards_samples_cleanup branch 3 times, most recently from 1a20e84 to ea78666 Compare September 9, 2024 18:20
@kartben kartben marked this pull request as ready for review September 9, 2024 18:21
@kartben kartben requested a review from carlescufi as a code owner September 9, 2024 18:22
Group all STM32 board samples in samples/boards/st to
keep samples/boards/ organized by vendor

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Quicklogic board samples in samples/boards/quicklogic to
keep samples/boards/ organized by vendor

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Intel board samples in samples/boards/intel to
keep samples/boards/ organized by vendor
Added missing code-sample directive to the code relocation sample.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Phytec board samples in samples/boards/phytec to
keep samples/boards/ organized by vendor
Added zephyr-code-sample directive to mesh badge

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Google board samples in samples/boards/google to
keep samples/boards/ organized by vendor
Added zephyr-code-sample directive to twinkie sample

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Raspberry Pi board samples in samples/boards/raspberrypi to
keep samples/boards/ organized by vendor

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Nuvoton board samples in samples/boards/96boards to
keep samples/boards/ organized by vendor

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Enjoydigital board samples in samples/boards/enjoydigital to
keep samples/boards/ organized by vendor

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Adds missing code-sample directive to all the TI samples in
preparation for upcoming changes to the Zephyr documentation that will
be leveraging the provided description and metadata.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Board samples were listed in a very flat way before.
This commit introduces the appropriate toctrees to fix this.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
@kartben kartben dismissed stale reviews from erwango and gmarull via 46f81d5 September 12, 2024 14:35
@kartben kartben force-pushed the boards_samples_cleanup branch from d73408d to 46f81d5 Compare September 12, 2024 14:35
@kartben
Copy link
Collaborator Author

kartben commented Sep 12, 2024

@mmahadevan108 thanks for spotting this needed to be rebased :) done!

@marekmatej
Copy link

Espressif parts LGTM! Thanks for this helpful update!

@kartben
Copy link
Collaborator Author

kartben commented Sep 13, 2024

This has had approvals (either in current version of the PR on earlier version before a rebase was needed) from all the major vendors impacted by the change. I will be re-assigning to myself as this is in the samples area at the end of the day, and to make sure this can be merged sooner than later as it is likely to generate merge conflicts. Thanks everyone for the reviews!

@kartben kartben assigned kartben and unassigned MaureenHelm Sep 13, 2024
@carlescufi carlescufi merged commit d7e031c into zephyrproject-rtos:main Sep 13, 2024
23 checks passed
@kartben kartben deleted the boards_samples_cleanup branch September 13, 2024 12:14
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.