CLOUDP-305862: IPA 106 documentation standard #537
Conversation
| sortedRuleEntries.forEach((rule) => { | ||
| const severityFormatted = formatSeverity(rule.severity); | ||
| sections += `#### ${rule.name}\n\n ${severityFormatted} \n${rule.description}\n\n`; | ||
| sections += `#### ${rule.name}\n\n ${severityFormatted} \n${rule.description}`; |
There was a problem hiding this comment.
Could not understand ####. Should it represent heading level?
It is appended to the end of the IPA principle link in the documentation. Is it expected behavior?
There was a problem hiding this comment.
Yes. It is heading. Best way to understand it IMHO is to look at generated readme that is part of PR
There was a problem hiding this comment.
So this is a wrong one
http://go/ipa/102#### xgen-IPA-102-collection-identifier-camelCase but it should be something like
http://go/ipa/102
#### xgen-IPA-102-collection-identifier-camelCase
There was a problem hiding this comment.
yes. I do not wanted to touch other ipas. Will revert that fix and make it as last fix after all docs changes are done
There was a problem hiding this comment.
We need to fix those in descriptions by changing way we format multi line descriptions :D
2 participants
Proposed changes
First PR covering new documentation standards.
Looking for extra feedback to formalize pattern for follow up PRs.