WIP: first version of score book #1932
Conversation
|
|
|
The created documentation from the pull request is available at: docu-html |
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
| How-Tos |
There was a problem hiding this comment.
Why is this not called Handbook directly?
| @@ -0,0 +1,16 @@ | |||
|
|
|||
| S-Core Book | |||
There was a problem hiding this comment.
in general we use in other documentation S-CORE (Big letters), the comment applies to the whole document
| ========================== | ||
|
|
||
| As it was already stated in the "Overview of the technologies" part, S-Core project consists of multiple | ||
| bazel modules, normally located in separate repositories. Majority of S-Core modules are part of S-Core |
There was a problem hiding this comment.
Bazel-Modules, according to our model Modules realized as Bazel-Modules
|
|
||
| S-Core module is the central part of the s-core project, where the software architecture is defined. Here you will find the list and explanation of the features, | ||
| that are provided by the S-Core platform, definition of the high level architecture, break down of the high level architecture to the modules | ||
| and the definition of the functionality (logical interfaces) for every module. |
There was a problem hiding this comment.
You miss here PMP, which defines the deployment of the Process Definition in process_description, Tool Lists, Design Decisions, and Requirements
| We automatically generate for every repository html documentation from rst files. | ||
| You can easily open it as shown at the picture (TODO: Link) | ||
|
|
||
| The process repository defines the S-Core process. It defines both general concepts and ideas of the S-Core software development process approach and |
There was a problem hiding this comment.
It defines Processes compliant to standards, a kind of Framework, Management System, independent from any tools. The PMP in the s-core repo documents, how they are deployed in S-CORE.
That's why it can also used for other projects outside S-CORE.
2018000 to
68b232e
Compare
6746b36 to
dd73027
Compare
| @@ -0,0 +1,181 @@ | |||
| <root> ([email protected]) | |||
dd73027 to
35f802b
Compare
35f802b to
31290aa
Compare
Very first draft, work in progress
direct link: https://eclipse-score.github.io/score/pr-1932/how_tos/score_book/introduction.html