-
Notifications
You must be signed in to change notification settings - Fork 44
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
Organize Sample Code #2912
base: main
Are you sure you want to change the base?
Organize Sample Code #2912
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2912 +/- ##
========================================
+ Coverage 5.97% 6.09% +0.12%
========================================
Files 171 175 +4
Lines 4334 4345 +11
Branches 476 474 -2
========================================
+ Hits 259 265 +6
- Misses 4073 4078 +5
Partials 2 2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
app/routes/docs.tsx
Outdated
@@ -162,7 +162,16 @@ export default function () { | |||
Java | |||
</Link>, | |||
<NavLink key="code-samples" to="client/samples"> | |||
Sample Code | |||
Kafka Messages |
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 talked about moving this out of the Kafka Client Setup
into a parallel documentation menu called Sample Code
or some other name, so moving it out of setup. Then you could have all of these pages as SideNavSub
of them.
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.
Done
Very minor note, but maybe it would be better to have JSON/Healpix first? Also, I think the current Healpix doc is written more as a starter guide rather than a collection of sample code in the same way as the other two |
Some of the sample code is just general kafka usage, and not specific to the message serialization. There should be a separate section on sample code that's just general Kafka. |
Description
Re-organization of sample code is carried out as following:
-Kafka Messages
-XML
-JSON
-HEALPix
Related Issue(s)
#2851