Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit e2c6a17

Browse files
committed
#30 Use a consequent style of quotes and emphasise
- Quoting only the names of thethree phases from the graph. May we shouldemphasize them too. - Emphasize everything which is a special named thing in SCB. - Also fixes casing: Only names start with capital letter. Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
1 parent aea59d7 commit e2c6a17

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/adr/adr_0001.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ One major challenge implementing the _secureCodeBox_ is to provide a flexible an
3030
└──────────────────┘ └──────────────────┘ └──────────────────┘
3131
....
3232

33-
By now the phase 3 "`persisting`" was implemented by so called _persistenceProviders_ (e.g. the _persistence-elastic_ provider which is responsible for persisting all findings in a given elasticsearch database). The _secureCodeBox_ Operator is aware of this 3 phases and is responsible for the state model and execution of each security scan.
33+
By now the phase 3 "`persisting`" was implemented by so called _persistenceProviders_ (e.g., the _persistence-elastic_ provider which is responsible for persisting all findings in a given elasticsearch database). The _secureCodeBox_ Operator is aware of this 3 phases and is responsible for the state model and execution of each security scan.
3434

3535
=== Problem and Question
3636

37-
We identified different additional UseCases with a more _data processing oriented_ pattern than the implemented _persisting phase3_ indicates. For example, we implemented a so called "MetaDataProvider" feature, which is responsible for enhancing each security finding with additional metadata. But the MetaDataProvider must be executed after the _parsing phase 2_ and before the _persisting phase 3_ because it depends on the parsed finding results (which will be enhanced) and the update findings should be also persisted.
37+
We identified different additional use cases with a more "`data processing oriented`" pattern than the implemented phase 3 "`persisting`" indicates. For example, we implemented a so called _MetaDataProvider_ feature, which is responsible for enhancing each security finding with additional metadata. But the _MetaDataProvider_ must be executed after the phase 2 "`parsing`" and before the phase 3 "`persisting`" because it depends on the parsed finding results (which will be enhanced) and the updated findings should be also persisted.
3838

3939
To find a proper solution, we split the topic into the following two questions:
4040

0 commit comments

Comments
 (0)