Skip to content

Commit a853a29

Browse files
authored
typo fix / small bugs (#2503)
1 parent f4769c4 commit a853a29

10 files changed

Lines changed: 25 additions & 21 deletions

.vscode/settings.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,12 @@
8888
},
8989
"cSpell.words": [
9090
"__getitem__",
91+
"baselibs",
9192
"bazel",
9293
"buildifier",
94+
"Codeowner",
95+
"codeowners",
96+
"docname",
9397
"getstrt",
9498
"metatags",
9599
"reqs"

docs/platform_management_plan/change_management.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ If the information is sufficient and it is decided to implement the change reque
274274
ISSUE status is kept ``Open`` and the Projects status is set to ``In Progress``.
275275

276276
The decision, if the change request is accepted or rejected must be documented. Safety/Security
277-
experts must confirm or disconfirm, if safety/security relevance is set correctly.
277+
experts must confirm or deny, if safety/security relevance is set correctly.
278278

279279
:need:`gd_chklst__change_cr_review` can help to verify whether the information is complete.
280280

docs/platform_management_plan/documentation_management.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ Others are modelled as general documents (e.g. the plans which are part of the p
4646

4747
This plan deals with these documents, which have the following manually set attributes:
4848

49-
* Title: the name of the document (mandatory)
49+
* Title: The name of the document (mandatory)
5050
* Unique Id: Id following the naming pattern of the document Title (mandatory)
51-
* Safety: which ASIL the document supports (mandatory)
51+
* Safety: Which ASIL the document supports (mandatory)
5252
* Author: Who is the main committer to the document (mandatory)
53-
* Status: describing where in the lifecycle of the document it currently is (mandatory)
54-
* Tags: can be used to group documents for subsequent filtering (optional)
53+
* Status: Describing where in the lifecycle of the document it currently is (mandatory)
54+
* Tags: Can be used to group documents for subsequent filtering (optional)
5555

5656
Also the "Documentation Management" is a document, so an example for a correct document definition
5757
can be seen in the header section above, see :need:`doc__documentation_mgt_plan`.

docs/platform_management_plan/problem_resolution.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ To provide solutions, use the Solution part of the ISSUE.
137137

138138
:need:`[[title]] <gd_req__problem_attr_anaylsis_results>` is provided in the analysis
139139
results part of the ISSUE. State here, if the problem is accepted or rejected. Safety/Security
140-
experts must confirm or disconfirm, if safety/security is affected is set correctly
140+
experts must confirm or deny, if safety/security is affected is set correctly
141141

142142
:need:`[[title]] <gd_req__problem_attr_stakeholder>` are provided in the Assignees part of
143143
the ISSUE. In addition you can use pre-defined labels for Communities or Feature Teams
@@ -230,7 +230,7 @@ If the information is sufficient and it is decided to initiate the problem resol
230230
ISSUE status is kept ``Open`` and the Projects status is set to ``In Progress``.
231231

232232
The decision, if the problem is accepted or rejected must be documented. Safety/Security
233-
experts must confirm or disconfirm, if safety/security is affected is set correctly.
233+
experts must confirm or deny, if safety/security is affected is set correctly.
234234

235235
:need:`gd_chklst__problem_cr_review` can help to verify whether the information is complete.
236236

docs/platform_management_plan/project_management.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Technical committees
9898

9999
Every *Feature Team* should also have a *Feature Team Lead*. The person with this role is responsible for
100100
organizing the meetings, writing meeting protocols and representing the current status of the *Feature Team*
101-
work in various management reporting or plannig calls. *Feature Team Lead* is nominated by *Technical Leads* by election.
101+
work in various management reporting or planning calls. *Feature Team Lead* is nominated by *Technical Leads* by election.
102102
Normally, this is the owner of the original *Feature Request*.
103103

104104

@@ -107,8 +107,8 @@ Creation of a new Feature Team
107107
Decision to create a new *Feature Team* is normally done in *Technical Lead Circle* in case a particular,
108108
already *accepted* *Feature Request* can not be assigned to any of already existing *Feature Teams*.
109109

110-
As a first step, the decision to create a new Feature Team is protocolled in the `Tech Lead Circle meeeting minutes <https://github.com/orgs/eclipse-score/discussions/categories/technical-lead-circle>`_.
111-
Afterwards a GitHub Issue is created in the `Technical Lead Cirle LOP project <https://github.com/orgs/eclipse-score/projects/3>`_
110+
As a first step, the decision to create a new Feature Team is recorded in the `Tech Lead Circle meeting minutes <https://github.com/orgs/eclipse-score/discussions/categories/technical-lead-circle>`_.
111+
Afterwards a GitHub Issue is created in the `Technical Lead Circle LOP project <https://github.com/orgs/eclipse-score/projects/3>`_
112112
using the special *Feature Team Creation* GitHub Issue template and is assigned to one of the Technical Leads.
113113

114114
**ToDo**: create such a template.
@@ -182,10 +182,10 @@ technical competence of the software developers, e.g. in case during the :ref:`F
182182
it was decided to take over already existing source code, then persons who were actively participating in the
183183
development of that code are always good candidates to be part of *Codeowner GitHub team*.
184184
The decision who should be initially part of the *Codeowner GitHub team* and the reasoning for this
185-
should be protocolled in the GitHub Issue, that is used for creation of the *Feature Team*.
185+
should be recorded in the GitHub Issue, that is used for creation of the *Feature Team*.
186186

187-
In case further software developers should be added to the *Codeowener GitHub team* in the future,
188-
that decision and its reasoning should be protocolled in one of the *Feature Team* GitHub discussions.
187+
In case further software developers should be added to the *Codeowner GitHub team* in the future,
188+
that decision and its reasoning should be recorded in one of the *Feature Team* GitHub discussions.
189189

190190
Members of the *Codeowner GitHub team* should also be authorized to merge pull requests (PRs) into the corresponding repository.
191191
Therefore, once the *Codeowner GitHub team* has been created, the Technical Lead assigned to the ticket for the *Feature

docs/platform_management_plan/quality_management.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,11 +182,11 @@ The metric for the work products is ensured by the process that contains the wor
182182

183183
3.5 Quality Management Scope
184184
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
185-
There is no deviation from the scope defined in the :need:`doc__project_mgt_plan`. The platform and its
185+
There is no deviation from the scope defined in the :need:`doc__project_mgt_plan`. The platform and it's
186186
components are developed, and integrated for an assumed technical system, for functional safety purposes as
187187
Safety Element out of Context (SEooC).
188188

189-
The development of the platform and its components follows the defined processes. Responsibilities for management,
189+
The development of the platform and it's components follows the defined processes. Responsibilities for management,
190190
development, implementation, integration, and verification are also defined in the processes.
191191

192192
The SW platform consists of features, which are based on a set of requirements and are developed in parallel.

docs/platform_management_plan/release_management.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
:tags: platform_management
2121
:realizes: wp__platform_sw_release_plan
2222

23-
Release management Plan
23+
Release Management Plan
2424
-----------------------
2525

2626
This document implements parts of the :need:`wp__platform_mgmt`.
@@ -73,7 +73,7 @@ Release Planning and Execution
7373
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7474

7575
Generally release planning and execution is described in :need:`wf__rel_mod_rel_note` process.
76-
It is part of project planning and therefore also documented with the same means. Generally a Release
76+
It is part of project planning and therefore also documented with the same means. Generally a release
7777
is planned as an issue linked to a milestone in the `GitHub Milestone Planning <https://github.com/orgs/eclipse-score/projects/13>`_.
7878
And this issue is closed by merging a pull request which creates/updates a release note.
7979

docs/platform_management_plan/role_assignment/platform_safety_manager.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Education and Skills:
5555
- Safety related SW development and project management (in aerospace) > 10 years - letters of recommendation from employers
5656
- Trainer for DO-178B SW safety standard - election certificate
5757
- Process development CMMI - letters of recommendation from employers
58-
- Safety trainings by Exida (Iso 26262) - part of Safety Case Safe Posix SW platform
58+
- Safety trainings by Exida (ISO 26262) - part of Safety Case Safe Posix SW platform
5959

6060
S-CORE Committs:
6161

docs/platform_management_plan/safety_management.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Functional Safety Management Scope
6060
There is no deviation from the scope presented in the `S-CORE project page <https://eclipse-score.github.io/>`_ .
6161
The platform and its components are developed, and integrated for an assumed technical system as Safety Element out of Context (SEooC).
6262
The development of the platform and its components follows the defined processes.
63-
Responsibilities for development, implementation, integration and verification are also defined int the processes.
63+
Responsibilities for development, implementation, integration and verification are also defined in the processes.
6464

6565
Regarding the platform specifics:
6666

@@ -202,7 +202,7 @@ For the :need:`rl__project_lead`, the :need:`rl__safety_manager` and the :need:`
202202
in these project role definitions. They are also elected in a meritocratic way and this election is documented including the evidences checked to prove the experience.
203203

204204
Committers in the S-CORE project can work on the development of safety related or non-safety related SW modules.
205-
If they work on safety related modules they have to prove (additionaly to their committer election, which already shows they are skilled developers):
205+
If they work on safety related modules they have to prove (additionally to their committer election, which already shows they are skilled developers):
206206

207207
* two years practice of safety related SW development (or management) relevant for the section content (includes trainings in safety standards like ISO 26262)
208208
* training on the S-CORE processes

docs/platform_management_plan/software_verification.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ to be reached with every contribution.
330330
Further quality goals are defined in section :doc:`quality_management`.
331331

332332
The confirmation or any deviation of the coverage percentage value is documented in this section.
333-
This shall also be part of the module documenation with a reasoning when percentage numbers deviate for an official release.
333+
This shall also be part of the module documentation with a reasoning when percentage numbers deviate for an official release.
334334

335335
Coverage of detailed design
336336
^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)