-
Notifications
You must be signed in to change notification settings - Fork 7k
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
Re-organize board-specific samples per vendor and add zephyr:code-sample directive #78089
Conversation
8ef8cc1
to
88533e3
Compare
88710de
to
351220b
Compare
1a20e84
to
ea78666
Compare
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>
d73408d
to
46f81d5
Compare
@mmahadevan108 thanks for spotting this needed to be rebased :) done! |
Espressif parts LGTM! Thanks for this helpful update! |
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! |
.. zephyr:code-sample::
directivesNote 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