Skip to content

Document protocols with examples #2209

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

Merged
merged 3 commits into from
Jul 17, 2025
Merged

Document protocols with examples #2209

merged 3 commits into from
Jul 17, 2025

Conversation

jmthomas
Copy link
Member

No description provided.

Copy link

codecov bot commented Jul 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.26%. Comparing base (7dce229) to head (6e12002).
Report is 17 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2209      +/-   ##
==========================================
+ Coverage   80.23%   80.26%   +0.02%     
==========================================
  Files         638      638              
  Lines       47616    47628      +12     
  Branches      745      745              
==========================================
+ Hits        38207    38230      +23     
+ Misses       9326     9315      -11     
  Partials       83       83              
Flag Coverage Δ
python 83.91% <ø> (+0.07%) ⬆️
ruby-api 84.70% <ø> (ø)
ruby-backend 82.97% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@@ -45,7 +45,7 @@ Here is a snippet of code showing [PORT](../configuration/plugins#port-1) and [R
```bash
VARIABLE cfdp_microservice_name CFDP
VARIABLE cfdp_route_prefix /cfdp
VARIABLE cfdp_port 2905
VARIABLE cfdp_port 2906
Copy link
Member Author

Choose a reason for hiding this comment

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

The actual CFDP port is 2906 so updating to match.

@@ -66,15 +66,15 @@ Here is an example using [PORT](../configuration/plugins#port) and [ROUTE_PREFIX
```bash
VARIABLE my_interface_name MY_INT
VARIABLE my_route_prefix /myint
VARIABLE my_port 2910
VARIABLE my_port 2888
Copy link
Member Author

Choose a reason for hiding this comment

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

2910 is now taken by calendar-api so updating to differentiate

// Re-use the default mapping
...MDXComponents,
Tabs,
TabItem,
Copy link
Member Author

Choose a reason for hiding this comment

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

This registers Tabs and TabItem so we can use them in our markdown

@jmthomas
Copy link
Member Author

Provides a nice linked tab switch to Python or Ruby:

Screenshot 2025-07-16 at 1 18 13 PM

@jmthomas jmthomas requested a review from ryanmelt July 17, 2025 19:21
@jmthomas jmthomas merged commit 683305a into main Jul 17, 2025
18 of 19 checks passed
@jmthomas jmthomas deleted the protocol_docs branch July 17, 2025 20:50
Copy link

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