CLOUDP-305862 - format of the docs #533
Conversation
|
|
||
| function getIpaRulesetUrl(ipaNumber) { | ||
| return `[${ipaNumber}.yaml](https://github.com/mongodb/openapi/blob/main/tools/spectral/ipa/rulesets/${ipaNumber}.yaml)`; | ||
| return `[http://go/ipa/${ipaNumber}.yaml](http://go/ipa/${ipaNumber}.yaml)`; |
There was a problem hiding this comment.
Should this link to the IPA Pine docs?
There was a problem hiding this comment.
We agreed that validator description provides much more value for users than repeated validator description in pine docs. Made fix. let me know what you think now.
tools/spectral/ipa/__tests__/collectionIdentifierCamelCase.test.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/__tests__/collectionIdentifierCamelCase.test.js
Outdated
Show resolved
Hide resolved
| ### IPA-005 | ||
|
|
||
| For rule definitions, see [IPA-005.yaml](https://github.com/mongodb/openapi/blob/main/tools/spectral/ipa/rulesets/IPA-005.yaml). | ||
| Rule is based on [http://go/ipa/IPA-005](http://go/ipa/IPA-005). |
There was a problem hiding this comment.
| Rule is based on [http://go/ipa/IPA-005](http://go/ipa/IPA-005). | |
| Rule is based on [http://go/ipa/IPA-5](http://go/ipa/IPA-5). |
Last comment 😅 Unfortunately these golinks for numbers < 10 don't have the 00 in front, so this one is 404 currently
There was a problem hiding this comment.
Ah.. that is why we had those manually specified. Adding simple logic to cover it
| function formatSeverity(severity) { | ||
| switch (severity.toLowerCase()) { | ||
| case 'info': | ||
| return ''; |
There was a problem hiding this comment.
[a11ly]
| return ''; | |
| return ''; |
screen readers will read the text here since images are not accessible, also did we try emojis?
ℹ️
There was a problem hiding this comment.
Yes. I had them initially mixed with those but we decided to keep those instead. Adding a11ly change
3 participants
Proposed changes
Change format of the document to use sections as tables do not support markdown format.
That restricts us to document each rule.
Avoid repeating url to IPA website (private) it is now mentioned on the top once.
Link directly to implementation from the ipa failure giving user more details on the rule specifics.