Add Documentation for Source Code Linker #2461
Conversation
|
|
| @@ -0,0 +1,125 @@ | |||
| .. | |||
There was a problem hiding this comment.
I would just call it code tracability tooling as geenral tools means nothing.
|
The created documentation from the pull request is available at: docu-html |
| """Your function that implements the requirement partiall or fully""" | ||
| ... | ||
|
|
||
| The parser will look through most files but not those that fulfil any of these properties |
There was a problem hiding this comment.
hard to understand sentence
There was a problem hiding this comment.
Re-wrote it.
| The implementation here differs based on your source code language though. | ||
| So it is best if you read up in the language you want to develop in how to do this. | ||
|
|
||
| In rough terms the data flow looks as follows. |
There was a problem hiding this comment.
In rough terms the data flow looks as follows:
|
|
||
| You can now also do statistics on your tests. `Docs as Code Test Statistics examples <https://eclipse-score.github.io/docs-as-code/main/internals/requirements/test_overview.html>`_ | ||
|
|
||
|
|
There was a problem hiding this comment.
I think this needs betetr explanation and not just "in cloud" one. @PiotrKorkus maybe some comments ?
There was a problem hiding this comment.
Is this comment on the wrong line? I can't quiet follow you here.
There was a problem hiding this comment.
agree, maybe you can provide codeblock with ..needtable & ..needpie examples? Button edit on github still doesn't work, so it can be difficult to others to quickly find the code.
Also I would appreciate information if cross-repo linking and reporting is possible
| `Python implementation [NOT LINKED YET]` | ||
| `RUST Implementation [NOT LINKED YET]` | ||
| `CPP Implementation [NOT LINKED YET]` | ||
|
|
There was a problem hiding this comment.
Do we need this ? Isn;t this enought to just link to doc-as-code and thats it ?
There was a problem hiding this comment.
How you do the testing properties in each is different, so we most likely should describe that quickly with an example?
As in 'docs-as-code' only the python one is described (if even)
| Traceability Tooling | ||
| #################### | ||
|
|
||
| This document describes tools or some functionality of them, that can be used regardless of source code language.These tools are also provided by S-CORE projects, like Docs-As-Code. |
There was a problem hiding this comment.
"This document describes tools or some functionality of them" The whole description in this doc shall be precise imho as this is what will be used.
| Link Requirements to Tests | ||
| ************************** | ||
|
|
||
| There is a tool that has the ability to link requirements to your tests as well as provide virtual tests needs in order to make statistics etc. possible to be rendered. |
There was a problem hiding this comment.
This sentence is a bit weird :D, I re-word it and add the link to the tool.
| In rough terms the data flow looks as follows. | ||
|
|
||
| Your testing framework produces XML files with pre-defined properties. | ||
| These XML files get read in and parsed. The test needs get build from the parsed data and linked to the requirements mentioned. |
There was a problem hiding this comment.
These XML files are loaded and parsed. The test needs to get build details from the parsed data and link it to the requirements mentioned. ?
There was a problem hiding this comment.
This sounds nicer. Will adopt this wording.
|
|
||
| You can now also do statistics on your tests. `Docs as Code Test Statistics examples <https://eclipse-score.github.io/docs-as-code/main/internals/requirements/test_overview.html>`_ | ||
|
|
||
|
|
There was a problem hiding this comment.
agree, maybe you can provide codeblock with ..needtable & ..needpie examples? Button edit on github still doesn't work, so it can be difficult to others to quickly find the code.
Also I would appreciate information if cross-repo linking and reporting is possible
| """Your function that implements the requirement partiall or fully""" | ||
| ... | ||
|
|
||
| An rendered example of a need where this is implemented can be seen in `Rendered Example <https://eclipse-score.github.io/docs-as-code/main/internals/requirements/requirements.html#tool_req__docs_common_attr_id>`_ |
Incooperating PR comments Adding screenshot of rendered example instead of linking to it
3 participants
This will add additional documentation for developers about the Source Code Linker and it's capabilities.