persistency/examples: Provide a integration example#247
persistency/examples: Provide a integration example#247umaucher wants to merge 2 commits intoeclipse-score:mainfrom
Conversation
Show how to integrate score_persistency in a own standalone bazel workspace and showing the usage of the C++ implementation. Remove the previous pseudo code from the README.md and document the new solution instead.
License Check Results🚀 The license check job ran with the Bazel command: bazel run //:license-checkStatus: Click to expand output |
|
The created documentation from the pull request is available at: docu-html |
| # only in the intern examle to test the latest local version instead of the latest released one | ||
| local_path_override( | ||
| module_name = "score_persistency", | ||
| path = "../", |
There was a problem hiding this comment.
Should this be here?
There was a problem hiding this comment.
yes ... it is ment as hint for other modules which want to use persistency that they don't (need) do it
| @@ -0,0 +1,63 @@ | |||
| # ******************************************************************************* | |||
There was a problem hiding this comment.
please dont use seperate bazelmod. This example folder once done, will be auto deployed into refernce integration images to showcase persistency
arkjedrz
left a comment
There was a problem hiding this comment.
I'm not 100% convinced to this change, even though I see good things about it.
- An additional example is a good thing. C++ version was missing them. Rust have them in
src/rust/rust_kvs/examplesdirectory - this is due toexamples/being a special directory in Cargo.
Should<root>/examples/be removed, and C++ examples moved tosrc/cpp/? Or should<root>/examples/reworked to contain both C++ and Rust examples? - IMO having a separated workspace doesn't really help with understanding how to integrate, it just increases noise level.
- I didn't read through all the
README.md, but I see a lot of warnings frommarkdownlint- I recommend it for linting Markdown files.
As i commented out, this will prohibit usage of exmaples in reference integration. |
|
One thing that this does not describe is the Properties (that are needed for Docs-As-Code to generate testlinks). Is this something we want to add here? |
Show how to integrate score_persistency in a own standalone bazel workspace and showing the usage of the C++ implementation. Remove the previous pseudo code from the README.md and document the new solution instead.