Fix the RPC Coverage Section for READMEs#5062
Conversation
Summary of ChangesHello @singhavnish2516, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the documentation quality across the repository by standardizing and enriching the 'OpenConfig Path and RPC Coverage' sections within various Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
The pull request primarily updates numerous README.md files across various feature directories by adding or replacing the OpenConfig Path and RPC Coverage sections. Specifically, many files now include a paths section detailing relevant OpenConfig paths for interfaces, network instances, BGP, routing policies, QoS, components, and other system-level configurations. Several files also saw minor reorganizations of RPC lists or removal of Canonical OC JSON examples. The reviewer's comments highlight the removal of the Canonical OC section in feature/acl/otg_tests/acl_update_test/README.md and feature/gribi/otg_tests/encap_frr/README.md, requesting its restoration or clarification, as it is a required part of the test plan template.
I am having trouble creating individual review comments. Click here to see my feedback.
feature/acl/otg_tests/acl_update_test/README.md (58-186)
The Canonical OC section has been removed. According to the test plan template (doc/test-requirements-template.md), this section is required in the test's README.md. Please restore this section or clarify why it's being removed. If it's no longer needed, the template should be updated.
feature/gribi/otg_tests/encap_frr/README.md (486-489)
The Canonical OC section has been removed. According to the test plan template (doc/test-requirements-template.md), this section is required in the test's README.md. Please restore this section or clarify why it's being removed. If it's no longer needed, the template should be updated.
feature/gribi/otg_tests/encap_frr_with_reencap_vrf_test/README.md (587-590)
The Canonical OC section has been removed. According to the test plan template (doc/test-requirements-template.md), this section is required in the test's README.md. Please restore this section or clarify why it's being removed. If it's no longer needed, the template should be updated.
Removed unused OpenConfig paths from the README.
Pull Request Test Coverage Report for Build 21973864787Details
💛 - Coveralls |
Removed unused component state entries from README.
Removed unnecessary question mark from adjacency-state entry.
Added platform_type to OpenConfig path configuration.
Add platform_type to OpenConfig path for integrated circuit.
…ten by the tool, checked for duplicates as well (#5063)
Removed several invalid BGP BMP configuration and state paths from the README.
Removed unnecessary paths from the README.
Removed TODO note about updating Paths and RPCs.
Added TODO comments for pending states related to BMP configuration.
Removed redundant sections on configuration and telemetry parameter coverage from the README.
Removed Sub Test 4 from README.md
dplore
left a comment
There was a problem hiding this comment.
Lgtm, needs a merge conflict fixed and then you should be able to complete the merge
* Fix readme initial commit * Fix README headings * Remove duplicate README. Already covered in feature/bgp/otg_tests/bgp_afi_safi_defaults * Fix READMEs * Fix formatting in README for encap_frr_with_reencap_vrf_test * Remove unused OpenConfig paths from README Removed unused OpenConfig paths from the README. * Clean up README by removing unused state components Removed unused component state entries from README. * Add platform_type to OpenConfig path in README * Refactor YAML paths in BGP multipath ECMP test README * Fix formatting of BGP policy paths in README * Refactor BGP neighbor configuration in README * Refactor BGP actions in README for clarity * Fix formatting in README.md for adjacency state * Fix formatting of adjacency-state entry in README * Fix formatting in isis_drain_test README Removed unnecessary question mark from adjacency-state entry. * Update README with platform_type for node-id Added platform_type to OpenConfig path configuration. * Update README with platform_type for node-id Add platform_type to OpenConfig path for integrated circuit. * Add platform_type to OpenConfig path coverage * Add platform_type for component state description * Add platform_type for integrated circuit paths * Add platform_type to OpenConfig paths in README * Added back all the OC paths and non-OC path content that was overwritten by the tool, checked for duplicates as well (openconfig#5063) * Remove obsolete invalid BGP BMP paths from README Removed several invalid BGP BMP configuration and state paths from the README. * Update README to remove obsolete user config paths Removed unnecessary paths from the README. * Add platform_type for integrated circuit counters * Remove TODO for Paths and RPCs update Removed TODO note about updating Paths and RPCs. * Document pending BMP states in README Added TODO comments for pending states related to BMP configuration. * Update README to remove redundant coverage sections Removed redundant sections on configuration and telemetry parameter coverage from the README. * Delete Sub Test 4 from ACL update test documentation Removed Sub Test 4 from README.md * Add GRE encapsulation src and dst IP config paths * Add GRE encapsulation src and dst IP fields to README --------- Co-authored-by: chitadi <119812932+chitadi@users.noreply.github.com>
No description provided.