Commit Graph

21 Commits

Author SHA1 Message Date
Fin Maaß 3887f41ef9 doc: fix links to wiki
This fixes the broken links to the zephyr wiki.

Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>
2024-08-30 09:07:52 +02:00
Benjamin Cabé 704421cc83 doc: clean-up Development Environment and Tools page
GitHub labels were hard to visually parse so use guilabel role to make them
stand out more, and put them in tabular format.
Other minor cosmetic tweaks

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-06-20 14:07:32 -04:00
Pisit Sawangvonganan 512dc9ff38 doc: fix typo in multiple directories (build, hardware, kernel, project)
Utilize a code spell-checking tool to scan for and correct spelling errors
in all files within the doc/build, hardware, kernel, project directory.

Signed-off-by: Pisit Sawangvonganan <pisit@ndrsolution.com>
2024-01-26 13:16:18 +01:00
Carles Cufi d053b8bf3b doc: Rename stable API change to breaking change
It is often confusing for users and developers alike to see the sentence
"stable API change" in a label or in the release notes. Stable APIs can
change in at least two ways (retaining compatibility or not), and so it
is preferrable to use a term that clearly describes the change as
incompatible, by using the common term "breaking".

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2023-12-20 09:12:44 -05:00
Anas Nashif 538abf3332 doc: clarify role of CODEOWNERS and MAINTAINERS files
Change docs to use MAINTAINERS file as the main file for managing code
areas and 'ownership'.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-16 08:19:15 -05:00
Carles Cufi 74d904ba72 doc: gh: Add RFC to the list of mandatory labels
The paragraph that lists the mandatory labels (at least one of them must
be set, and at most one of those) was missing RFC.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-06-30 17:01:58 -04:00
Carles Cufi 1c2873f2f3 doc: gh: Document the Hardware Support label
This label is widely used by not documented.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-06-30 17:01:58 -04:00
Carles Cufi 974e868b33 doc: gh: Remove the doc for the "Question" label
This label has been removed, since we now convert issues that are just
questions to Discussions.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-06-30 17:01:58 -04:00
Aleksandar Markovic e36fccbbf9 doc: Reword and reformat a sentence on review time
Move the sentence to the end of the section on labels applicable to
PRs only, reword it and convert to a note, indicating that the note
is for all labels in this section.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-06-28 15:55:21 +02:00
Aleksandar Markovic 641d2285b8 doc: Enhance subsection on "Security Review" label
Sync the text of description with what is seen in Github.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-06-28 15:55:21 +02:00
Aleksandar Markovic 4cdbdefb6d doc: Enhance subsection on "Maintainer" label
Sync the text of description with what is seen in Github.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-06-28 15:55:21 +02:00
Aleksandar Markovic 6e975769dd doc: Enhance subsection on "Hotfix" label
Sync the text of description with what is seen in Github.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-06-28 15:55:21 +02:00
Aleksandar Markovic 0836f71d3c doc: Enhance subsection on "Stable API Change" label
Remove part that it is not appropriate.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-06-28 15:55:21 +02:00
Aleksandar Markovic 60caee3a2f doc: Enhance description on "area: *" label
Use full label names for examples in the description, and other minor
enhancements.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-06-28 15:55:21 +02:00
Aleksandar Markovic 35e021d855 doc: Split and enhance subsections on "dev-review" and "TSC" labels
Split the explanation on dev-review and TSC labels into two separate ones,
and slightly reword both. For both, amend corresponding link to point to
the more relevant place in the online page on Zephyr meetings. Add
explanation for acronym "TSC".

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-06-28 15:55:21 +02:00
Aleksandar Markovic 3f20163cdd doc: Remove reference to now non-existant ext subdirectory
Directory <Zephyr-root>/ext does not exist anymore. Remove the
reference to it from the documentation.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-06-28 15:55:21 +02:00
Aleksandar Markovic ada4195834 doc: Move subsection on "Stale" label to the right place
Label "Stale" is used for both issues and pull requests. It is currenly
listed as applicaple to pull requests only, however. Move it to the
right place.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-06-28 15:55:21 +02:00
Aleksandar Markovic 02040834d9 doc: Fix label names to be in sync with Github label names
Some label names in the documentation do not match with what is
seen in Github interface. Fix it by syncing with Github.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-06-28 15:55:21 +02:00
Aleksandar Markovic 3f1e43b9c7 doc: Rearrange content of section "Labeling issues and pull requests"
Mostly due to limited support for tables in rst format, information on
labels used for Zephyr issues and pull requests in Github is hard to
navigate and is visually not pleasing. Rearange the content of the
section so that bullets are mainly utilized rather than tables. Format
label names as 'emphasis', rather that 'monospace' (which should be
used primarily for code snippets, and Github labels are not code).
Also, group the information according to applicability (taking into
account if a label is applicable to:

  * issues only;
  * pull requests only;
  * both issues and pull requests.

Label names and decriptions are otherwise left 'as is' in this commit.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-06-28 15:55:21 +02:00
Carles Cufi 26294ced09 doc: Rename API meeting to Architecture meeting
As per the decision to rename this meeting and make it into a working
group, document this in the official docs.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-06-14 16:07:38 +02:00
Anas Nashif 5b3b9c7c41 doc: create new section for project structure
Move all project and governance related docs into one new section.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00