feat(tooling): fix all report links and defers all audit content to the new audit section #1233
Conversation
…he new audit section
There was a problem hiding this comment.
Looks good! See a comment regarding the latest audit report date in the dashboard. Plus, can we please underline the dashboard entry (currently "Reports", or the actual date according to the comment), so that it's more clear that it's a link? Right now, you have hover over it in order to see it's a link.
| @@ -5,7 +5,7 @@ dashboardWeight: 2.0 | |||
| dashboardState: stable | |||
| dashboardTests: 0 | |||
| dashboardAudit: done | |||
| dashboardAuditURL: /#section-appendix.audit_reports.2020-06-03-gossipsub-design-and-implementation | |||
| dashboardAuditURL: /#section-appendix.audit_reports.gossipsub | |||
There was a problem hiding this comment.
Are you excluding the date from the section header so that it always points to this subsection and then multiple audits can be listed within the subsection without having to change the dashboardAuditURL every time someone adds a new report for the same protocol/repo? That's a good idea I think.
| @@ -5,7 +5,7 @@ dashboardWeight: 2.0 | |||
| dashboardState: stable | |||
| dashboardTests: 0 | |||
| dashboardAudit: done | |||
| dashboardAuditURL: /#section-appendix.audit_reports.2020-06-03-gossipsub-design-and-implementation | |||
| dashboardAuditURL: /#section-appendix.audit_reports.gossipsub | |||
| dashboardAuditDate: '2020-06-03' | |||
There was a problem hiding this comment.
I think we want to have the date of the latest report shown in the dashboard. Can it be pulled from here (dashboardAuditDate)?
There was a problem hiding this comment.
the problem is that it will be out of date with the audit section quickly, we either use the audit section content as the source of truth or the frontmatter properties.
There was a problem hiding this comment.
I see the point, but I think it's a requirement to have the date of the latest audit in the dashboard. I know this is in contrast to the change just above.
@daviddias are we ok if we don't have the latest audit date in the dashboard?
|
|
This PR fixes all the theory and security links that this PR #1230 broke.
Also now that we have a new audit section with the all the audits content, we can just link to a specific sub section.
Some frontmatter properties were removed because the audit section already has them and more.
closes #1232