Add Benchmarks as a supported section on Resources (#1812)

This commit is contained in:
Costin Zaharia 2023-04-27 10:07:31 +02:00 committed by GitHub
parent 417657ca60
commit 5352da5b03
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 5 additions and 1 deletions

View File

@ -90,6 +90,7 @@ This new structure is defined as follows:
** Articles & blog posts
** Conference presentations
** Standards
** Benchmarks
Where the `How to fix it in {Framework Display Name}` section can be repeated multiple times when the rule description is defined per-framework.
@ -142,6 +143,7 @@ Goal: Allow the user to dig deeper by providing a curated list of resources.
* *Articles & blog posts* (level 3 title) [Optional]
* *Conference presentations* (level 3 title) [Optional]
* *Standards* (level 3 title) [Optional]
* *Benchmarks* (level 3 title) [Optional]
Note that most sections and subsections are optional, only the `Why is this an issue?` and `How to fix it`/ `How to fix it in {Framework Display Name}` main
sections are mandatory.

View File

@ -40,3 +40,4 @@ FIXME
//=== Articles & blog posts
//=== Conference presentations
//=== Standards
//=== Benchmarks

View File

@ -40,3 +40,4 @@ FIXME
//=== Articles & blog posts
//=== Conference presentations
//=== Standards
//=== Benchmarks

View File

@ -36,7 +36,7 @@ SECTIONS = {
'How to fix it': ['Code examples', 'How does this work?', 'Pitfalls', 'Going the extra mile'],
}
OPTIONAL_SECTIONS = {
'Resources': ['Documentation', 'Articles & blog posts', 'Conference presentations', 'Standards']
'Resources': ['Documentation', 'Articles & blog posts', 'Conference presentations', 'Standards', 'Benchmarks']
}
SUBSECTIONS = {
'Code examples': ['Noncompliant code example', 'Compliant solution']