Skip to content

docs: Verify/review config descriptions #1960

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 34 commits into from
Apr 9, 2025
Merged

docs: Verify/review config descriptions #1960

merged 34 commits into from
Apr 9, 2025

Conversation

maria-robobug
Copy link
Collaborator

@maria-robobug maria-robobug commented Mar 12, 2025 •
edited
Loading

  • Reviewed and modified descriptions.
  • Added some minor formatting.
  • Removed the "Key:" before every key name, seems redundant.

@maria-robobug maria-robobug changed the title Clio 989 config descriptions CLIO-989 - Verify/review config descriptions Mar 12, 2025
@maria-robobug maria-robobug changed the title CLIO-989 - Verify/review config descriptions docs: CLIO-989 - Verify/review config descriptions Mar 12, 2025
@kuznetsss
Copy link
Collaborator

@PeterChen13579, could you please bring these changes into code without updating the md file?

@kuznetsss
Copy link
Collaborator

@maria-robobug, could you please add a link to this file somewhere in docs?

@kuznetsss kuznetsss changed the title docs: CLIO-989 - Verify/review config descriptions docs: Verify/review config descriptions Mar 12, 2025
@kuznetsss kuznetsss self-requested a review March 12, 2025 15:17
@maria-robobug maria-robobug requested review from PeterChen13579 and kuznetsss and removed request for kuznetsss March 12, 2025 15:18
@maria-robobug
Copy link
Collaborator Author

@maria-robobug, could you please add a link to this file somewhere in docs?

@kuznetsss good point. I could reference it from the page below:
https://github.com/XRPLF/clio/blob/develop/docs/configure-clio.md

I'll update the PR shortly...

@codecov Codecov
Copy link

codecov bot commented Mar 12, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 62.92994% with 291 lines in your changes missing coverage. Please review.

Project coverage is 72.67%. Comparing base (427ba47) to head (945842f).
Report is 50 commits behind head on develop.

Files with missing lines Patch % Lines
src/etlng/ETLService.hpp 0.00% 84 Missing ⚠️
src/etlng/LoadBalancer.cpp 75.00% 24 Missing and 20 partials ⚠️
src/data/LedgerCache.cpp 0.00% 35 Missing ⚠️
src/etlng/Source.cpp 0.00% 16 Missing ⚠️
src/etlng/impl/SourceImpl.hpp 62.79% 4 Missing and 12 partials ⚠️
src/etl/ETLService.hpp 0.00% 14 Missing ⚠️
src/cluster/ClusterCommunicationService.cpp 86.90% 7 Missing and 4 partials ⚠️
src/app/ClioApplication.cpp 0.00% 9 Missing ⚠️
src/etlng/impl/ForwardingSource.cpp 79.54% 2 Missing and 7 partials ⚠️
src/web/ng/impl/HttpConnection.hpp 35.71% 8 Missing and 1 partial ⚠️
... and 14 more
Additional details and impacted files 
@@             Coverage Diff             @@
##           develop    #1960      +/-   ##
===========================================
- Coverage    72.71%   72.67%   -0.04%     
===========================================
  Files          333      354      +21     
  Lines        13525    14571    +1046     
  Branches      6881     7409     +528     
===========================================
+ Hits          9835    10590     +755     
- Misses        1785     1967     +182     
- Partials      1905     2014     +109

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

PeterChen13579
PeterChen13579 reviewed Mar 12, 2025
View reviewed changes
Copy link
Collaborator

@PeterChen13579 PeterChen13579 left a comment

Choose a reason for hiding this comment

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

Thanks for the review! 😃 Just one question

kuznetsss
kuznetsss requested changes Mar 18, 2025
View reviewed changes
kuznetsss and others added 28 commits April 9, 2025 09:42
@kuznetsss @PeterChen13579
chore: Upgrade libxrpl to 2.4.0 (XRPLF#1961)
09ddb6c
@PeterChen13579
optimize
3c1ffe8
@PeterChen13579
fix a few descriptions
deb6c43
@PeterChen13579
fix rest of description besides cursors
1650367
@kuznetsss @PeterChen13579
chore: Add git-cliff config (XRPLF#1965)
4536289 
First step for XRPLF#1779.
@PeterChen13579
fix: ripple_flag logic in account lines (XRPLF#1969)
9b37b2e 
fixes XRPLF#1968
@PeterChen13579
fix one more
1d09701
@PeterChen13579
fix cache description
dc9438a
@PeterChen13579
change marker/cursor description
1ce3ddb
@godexsoft @PeterChen13579
feat: ETLng extensions (XRPLF#1967)
634d1ae 
For XRPLF#1599 XRPLF#1597
@github-actions @PeterChen13579
style: clang-tidy auto fixes (XRPLF#1972)
1dde1ae 
Fixes XRPLF#1971. 
Co-authored-by: godexsoft <[email protected]>
@PeterChen13579
fix comments
9ea41fd
@PeterChen13579
fix min constraint value
23d8660
@cindyyan317 @PeterChen13579
feat: Snapshot import feature (XRPLF#1970)
5656e9b 
Implement snapshot import cmd
`clio_snapshot --server --grpc_server 0.0.0.0:12345 --path
<snapshot_path>`

Implement snapshot range cmd
`./clio_snapshot --range --path <snapshot_path>`

Add
LedgerHouses: It is responsible for reading/writing snapshot data
Server: Start grpc server and ws server
@kuznetsss @PeterChen13579
ci: Pin cmake 3.31.6 for macos runners (XRPLF#1983)
75da4ec 
Fixes XRPLF#1982.
@kuznetsss @PeterChen13579
fix: Fix ssl in new webserver (XRPLF#1981)
88fd6de 
Fixes XRPLF#1980.

An SSL handshake was missing and WsConnection should be build from
stream not socket because in case SSL connection stream already
completed SSL handshake.
@PeterChen13579
fix boost format link
da27097
@github-actions @godexsoft @PeterChen13579
style: clang-tidy auto fixes (XRPLF#1985)
c083fad 
Fixes XRPLF#1984.

Co-authored-by: godexsoft <[email protected]>
@PeterChen13579
fix: incorrect set HighDeepFreeze flag (XRPLF#1978)
173e271 
fixes XRPLF#1977
@godexsoft @PeterChen13579
chore: Update maintainers (XRPLF#1987)
66c008b
@github-actions @godexsoft @PeterChen13579
style: clang-tidy auto fixes (XRPLF#1989)
9a30c92 
Fixes XRPLF#1988. Please review and commit clang-tidy fixes.

Co-authored-by: godexsoft <[email protected]>
@PeterChen13579
change .md too
1986370
@godexsoft @PeterChen13579
chore: Update workflow notification settings (XRPLF#1990)
07b20c6
@godexsoft @PeterChen13579
feat: ETLng integration (XRPLF#1986)
020dc6e 
For XRPLF#1594
@github-actions @godexsoft @PeterChen13579
style: clang-tidy auto fixes (XRPLF#1992)
a2d0999 
Fixes XRPLF#1991. 

Co-authored-by: godexsoft <[email protected]>
@kuznetsss @PeterChen13579
feat: Nodes communication via DB (XRPLF#1976)
7660c27 
Fixes XRPLF#1966.
@github-actions @godexsoft @PeterChen13579
style: clang-tidy auto fixes (XRPLF#1994)
b38c6f4 
Fixes XRPLF#1993. 

Co-authored-by: godexsoft <[email protected]>
@godexsoft @PeterChen13579
chore: Fix clang-tidy 'fixes' (XRPLF#1996)
945842f 
Undo some of XRPLF#1994
@PeterChen13579 PeterChen13579 force-pushed the clio-989-config-descriptions branch from 07b13c8 to 945842f Compare April 9, 2025 16:42
@PeterChen13579 PeterChen13579 merged commit 4a5fee7 into XRPLF:develop Apr 9, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PeterChen13579 PeterChen13579 PeterChen13579 left review comments

@godexsoft godexsoft godexsoft approved these changes

@kuznetsss kuznetsss kuznetsss approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@maria-robobug @kuznetsss @godexsoft @PeterChen13579 @cindyyan317