-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add subsection with transition plan. #3
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here's my first cut at comments. Couple of general things:
jenkins
->Jenkins
(it's a product)kafka
->Kafka
(rest of the document used the capitalized version as does https://kafka.apache.org/intro)
The next step in the process is porting SAL to kafka. | ||
This will add support for the components written in C++ and Java. | ||
|
||
Having support for C++ is particularly critical as one of the core components of the system (the pointing component) is written in C++. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you are going down this road, add a statement here about the criticality of Java being important for the camera. Without the camera, we just have a big carnival ride. You can add a statement that we've prioritized C++ over Java to allow larger test coverage sooner.
|
||
#. Initial support for CI in jenkins. | ||
|
||
This step is probably going to happen in parallel to the SAL work and will be dedicated to adding support for running CI using the kafka version of our system in our jenkins server. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is probably going to
-> will
Once SAL C++ is available we can start deploying the TSSW components on TTS and running some initial tracking tests. | ||
We can start doing these tests even without the Java libraries (used by the camera) so we hope to focus on the C++ libraries first. | ||
|
||
At this point DDS is still our main development and deployment target, e.g. both ts_salobj and ts_sal will be supporting DDS and Kafka, where DDS will remain the main target. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These two line feel like they belong in the previous section.
At this point DDS is still our main development and deployment target, e.g. both ts_salobj and ts_sal will be supporting DDS and Kafka, where DDS will remain the main target. | ||
We do not expect developers to migrate to using kafka for development yet, except for a few early adopters. | ||
|
||
However, for this stage of the process we expect to make the initial release candidates for salobj and SAL. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you move the prior two sentences earlier, I would suggest rewording this a bit to something like: An initial release candidate for both SAL and salobj will be used to build the deployment artifacts for TTS testing.
At this point we expect that running CI jobs in jenkins will be fully supported. | ||
|
||
The main focus is to support running jobs for salobj and SAL kafka branches. | ||
We also should have in place the release jobs, that will make the SAL libraries available for C++ and Java. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We also should
-> We will
that will make
-> that make
|
||
#. Initial transition to Kafka. | ||
|
||
At this point all development and deployment will have been migrated to target the kafka version of tssw stack. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will have been
-> will have
#. Final transition to Kafka. | ||
|
||
Release of version 8 of salobj implementing breaking changes. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- What if the breaking changes require code changes to CSCs? Do we need to spell out what happens?
- Should we give a timeline for the endgame on
ts-idl
?
|
||
#. Developer migration. | ||
|
||
At this point TSSW developers are expected to migrate from the DDS version of salobj and SAL to the kafka version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are expected
-> must
At this point TSSW developers are expected to migrate from the DDS version of salobj and SAL to the kafka version. | ||
|
||
All development shall target the kafka version of salobj and SAL. | ||
At this time we expect developers might have to take some time fixing potential issues with unit tests to run their components against the kafka version of the tssw-stack. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the -
in tssw-stack
. You use a non-hyphenated version below.
|
||
After testing at the summit concludes we will evaluate the results and produce a technote with our findings | ||
|
||
If the test succeeds we can keep the summit running the Kafka version of our stack. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does succeed
mean here? How we will go about making this decision before tech note is written in case of a good outcome?
No description provided.