W-21487164-Add Protocol Buffer governance ruleset documentation - #107
Open
luanamulesoft wants to merge 5 commits into
Open
W-21487164-Add Protocol Buffer governance ruleset documentation#107luanamulesoft wants to merge 5 commits into
luanamulesoft wants to merge 5 commits into
Conversation
Added comprehensive documentation for validating .proto files through governance rulesets that check both syntax (linting) and semantic correctness (best practices) to ensure Protocol Buffer files meet organizational standards before deployment. Changes: - Created custom-rulesets-proto.adoc with detailed guide on creating, validating, and publishing Protocol Buffer governance rulesets - Updated navigation to include new Protocol Buffer rulesets page - Updated create-custom-rulesets.adoc to mention Protocol Buffer support - Updated index.adoc to include gRPC/Protocol Buffer in API types Co-authored-by: Cursor <cursoragent@cursor.com>
Revised the Protocol Buffer governance ruleset documentation to: - Remove passive voice constructions (changed "are deployed" to "deploying", "is correctly formatted" to "has correct formatting", etc.) - Improve conciseness by removing wordy phrases - Use active voice throughout (changed "ensure you have" to direct imperatives) - Replace "e.g." with "for example" per style guide - Simplify complex sentences for better readability - Use direct, action-oriented language All changes align with CX Style Guide requirements for clarity, conciseness, and avoiding passive voice. Co-authored-by: Cursor <cursoragent@cursor.com>
Updated API Governance documentation to include gRPC in the list of governable API types wherever they are mentioned: - Index page (API Governance Overview) - Dashboard Overview page - Dashboard Key Metrics partial - Create Custom Rulesets page (AMF supported formats) Removed the custom-rulesets-proto.adoc file and its navigation entry as detailed ruleset documentation is not needed at this time. Changes: - Added gRPC to API type lists in index.adoc, dashboard-overview.adoc, and dashboard-key-metrics.adoc - Updated AMF supported formats to include gRPC in create-custom-rulesets.adoc - Deleted custom-rulesets-proto.adoc - Removed proto rulesets entry from navigation Co-authored-by: Cursor <cursoragent@cursor.com>
Updated AMF custom validation documentation links from the old a.ml domain to the new Salesforce GitHub Pages location: - Old: https://a.ml/docs/amf/using-amf/amf_custom_validation/ - New: https://salesforce-misc.github.io/amf-docs/docs/amf/using-amf/amf_custom_validation Files updated: - modules/ROOT/pages/create-custom-rulesets.adoc - modules/ROOT/pages/custom-rulesets-new.adoc Co-authored-by: Cursor <cursoragent@cursor.com>
Cristian-Venticinque
approved these changes
Feb 19, 2026
luanamulesoft
changed the title
luanamulesoft
added a commit
that referenced
this pull request
Mar 16, 2026
Replicate PR #107 changes: - Add gRPC to API type lists in index.adoc, dashboard-overview.adoc, and dashboard-key-metrics.adoc - Update create-custom-rulesets.adoc: AMF supported formats (gRPC), AMF Custom Validation link, MuleSoft Ideas Portal link - Update custom-rulesets-new.adoc: AMF Custom Validation link, MuleSoft Ideas Portal link Made-with: Cursor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added comprehensive documentation for validating .proto files through governance rulesets that check both syntax (linting) and semantic correctness (best practices) to ensure Protocol Buffer files meet organizational standards before deployment.
Changes: