Skip to content
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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Conversation

Vidushi-GitHub
Copy link
Member

Description

Re-organization of sample code is carried out as following:
-Kafka Messages
-XML
-JSON
-HEALPix

Related Issue(s)

#2851

@Vidushi-GitHub
Copy link
Member Author

Style reference:
Screenshot 2025-02-21 at 4 22 20 PM

Copy link

codecov bot commented Feb 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 6.09%. Comparing base (6a9c6a9) to head (d648cc2).
Report is 12 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@@ -162,7 +162,16 @@ export default function () {
Java
</Link>,
<NavLink key="code-samples" to="client/samples">
Sample Code
Kafka Messages
Copy link
Contributor

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@Vidushi-GitHub
Copy link
Member Author

Screenshot 2025-02-24 at 12 56 41 PM

@tylerbarna
Copy link
Member

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

@jracusin
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants