Skip to content

Commit

Permalink
fix: remark-lint unordered-list-marker-style
Browse files Browse the repository at this point in the history
  • Loading branch information
nschonni authored and benhalverson committed Sep 20, 2020
1 parent 155dd91 commit f4fe4ff
Show file tree
Hide file tree
Showing 7 changed files with 217 additions and 218 deletions.
3 changes: 1 addition & 2 deletions .remarkrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"remark-frontmatter",
"remark-preset-lint-node",
["remark-lint-first-heading-level", false],
["remark-lint-maximum-line-length", false],
["remark-lint-unordered-list-marker-style", false]
["remark-lint-maximum-line-length", false]
]
}
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## Vocabulary

- A **Contributor** is any individual creating or commenting on an issue or pull request,
* A **Contributor** is any individual creating or commenting on an issue or pull request,
or contributing in some other way.
- A **Collaborator** is a contributor who has been given write access to the repository.
* A **Collaborator** is a contributor who has been given write access to the repository.

## Commit Guidelines

Expand Down
188 changes: 94 additions & 94 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,9 @@ The `src/documentation` directory currently contains all the getting started con

Looking for more guidance? Full documentation for Gatsby lives [on the website](https://next.gatsbyjs.org/). Here are some places to start:

- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://next.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
* **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://next.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.

- **To dive straight into code samples head [to our documentation](https://next.gatsbyjs.org/docs/).** In particular, check out the "Guides", API reference, and "Advanced Tutorials" sections in the sidebar.
* **To dive straight into code samples head [to our documentation](https://next.gatsbyjs.org/docs/).** In particular, check out the "Guides", API reference, and "Advanced Tutorials" sections in the sidebar.

## 🏛 Governance

Expand Down Expand Up @@ -165,33 +165,33 @@ also have commiter rights on the repo.

<!-- ncu-team-sync.team(nodejs/nodejs-dev) -->

- [@ahmadawais](https://github.com/ahmadawais) - Ahmad Awais ⚡️
- [@alexandrtovmach](https://github.com/alexandrtovmach) - Alexandr Tovmach
- [@amiller-gh](https://github.com/amiller-gh) - Adam Miller
- [@argyleink](https://github.com/argyleink) - Adam Argyle
- [@benhalverson](https://github.com/benhalverson) - Ben Halverson
- [@BeniCheni](https://github.com/BeniCheni) - Benjamin Chen
- [@codeekage](https://github.com/codeekage) - Abraham Jr. Agiri
- [@darcyclarke](https://github.com/darcyclarke) - Darcy Clarke
- [@designMoreWeb](https://github.com/designMoreWeb) - Divy Tolia
- [@imbhargav5](https://github.com/imbhargav5) - Bhargav Ponnapalli
- [@jonchurch](https://github.com/jonchurch) - Jonathan Church
- [@kasicka](https://github.com/kasicka) - Zuzana Svetlíková
- [@keywordnew](https://github.com/keywordnew) - Manil Chowdhury
- [@LaRuaNa](https://github.com/LaRuaNa) - Onur Laru
- [@maddhruv](https://github.com/maddhruv) - Dhruv Jain
- [@mbj36](https://github.com/mbj36) - Mohit kumar Bajoria
- [@MylesBorins](https://github.com/MylesBorins) - Myles Borins
- [@ogonzal87](https://github.com/ogonzal87) - Oscar Gonzalez
- [@ollelauribostrom](https://github.com/ollelauribostrom) - Olle Lauri Boström
- [@pierreneter](https://github.com/pierreneter)
- [@sagirk](https://github.com/sagirk) - Sagir Khan
- [@saulonunesdev](https://github.com/saulonunesdev) - Saulo Nunes
- [@skllcrn](https://github.com/skllcrn) - Christopher
- [@SMotaal](https://github.com/SMotaal) - Saleh Abdel Motaal
- [@timothyis](https://github.com/timothyis) - Timothy
- [@tstreamDOTh](https://github.com/tstreamDOTh) - T Thiyagaraj
- [@ZYSzys](https://github.com/ZYSzys) - ZYSzys
* [@ahmadawais](https://github.com/ahmadawais) - Ahmad Awais ⚡️
* [@alexandrtovmach](https://github.com/alexandrtovmach) - Alexandr Tovmach
* [@amiller-gh](https://github.com/amiller-gh) - Adam Miller
* [@argyleink](https://github.com/argyleink) - Adam Argyle
* [@benhalverson](https://github.com/benhalverson) - Ben Halverson
* [@BeniCheni](https://github.com/BeniCheni) - Benjamin Chen
* [@codeekage](https://github.com/codeekage) - Abraham Jr. Agiri
* [@darcyclarke](https://github.com/darcyclarke) - Darcy Clarke
* [@designMoreWeb](https://github.com/designMoreWeb) - Divy Tolia
* [@imbhargav5](https://github.com/imbhargav5) - Bhargav Ponnapalli
* [@jonchurch](https://github.com/jonchurch) - Jonathan Church
* [@kasicka](https://github.com/kasicka) - Zuzana Svetlíková
* [@keywordnew](https://github.com/keywordnew) - Manil Chowdhury
* [@LaRuaNa](https://github.com/LaRuaNa) - Onur Laru
* [@maddhruv](https://github.com/maddhruv) - Dhruv Jain
* [@mbj36](https://github.com/mbj36) - Mohit kumar Bajoria
* [@MylesBorins](https://github.com/MylesBorins) - Myles Borins
* [@ogonzal87](https://github.com/ogonzal87) - Oscar Gonzalez
* [@ollelauribostrom](https://github.com/ollelauribostrom) - Olle Lauri Boström
* [@pierreneter](https://github.com/pierreneter)
* [@sagirk](https://github.com/sagirk) - Sagir Khan
* [@saulonunesdev](https://github.com/saulonunesdev) - Saulo Nunes
* [@skllcrn](https://github.com/skllcrn) - Christopher
* [@SMotaal](https://github.com/SMotaal) - Saleh Abdel Motaal
* [@timothyis](https://github.com/timothyis) - Timothy
* [@tstreamDOTh](https://github.com/tstreamDOTh) - T Thiyagaraj
* [@ZYSzys](https://github.com/ZYSzys) - ZYSzys

<!-- ncu-team-sync end -->

Expand All @@ -203,80 +203,80 @@ participated in that process.

##### Information Gathering

- [@amiller-gh](https://github.com/amiller-gh) - **Adam Miller**
- [@codeekage](https://github.com/codeekage) - **Agiri Abraham JNR**
- [@darcyclarke](https://github.com/darcyclarke) - **Darcy Clarke**
- [@maddhruv](https://github.com/maddhruv) - **Dhruv Jain**
- [@fhemberger](https://github.com/fhemberger) - **Frederic Hemberger**
- [@JonahMoses](https://github.com/JonahMoses) - **Jonah Moses**
- [@chowdhurian](https://github.com/chowdhurian) - **Manil Chowdhury**
- [@oe](https://github.com/oe) - **Olivia Hugger**
- [@bnb](https://github.com/bnb) - **Tierney Cyren**
- [@timothyis](https://github.com/timothyis) - **Timothy**
* [@amiller-gh](https://github.com/amiller-gh) - **Adam Miller**
* [@codeekage](https://github.com/codeekage) - **Agiri Abraham JNR**
* [@darcyclarke](https://github.com/darcyclarke) - **Darcy Clarke**
* [@maddhruv](https://github.com/maddhruv) - **Dhruv Jain**
* [@fhemberger](https://github.com/fhemberger) - **Frederic Hemberger**
* [@JonahMoses](https://github.com/JonahMoses) - **Jonah Moses**
* [@chowdhurian](https://github.com/chowdhurian) - **Manil Chowdhury**
* [@oe](https://github.com/oe) - **Olivia Hugger**
* [@bnb](https://github.com/bnb) - **Tierney Cyren**
* [@timothyis](https://github.com/timothyis) - **Timothy**

##### IA / UX Planning

- [@oe](https://github.com/oe) - **Olivia Hugger**
- [@fhemberger](https://github.com/fhemberger) - **Frederic Hemberger**
- [@bnb](https://github.com/bnb) - **Tierney Cyren**
- [@timothyis](https://github.com/timothyis) - **Timothy**
- [@JonahMoses](https://github.com/JonahMoses) - **Jonah Moses**
- [@amiller-gh](https://github.com/amiller-gh) - **Adam Miller**
- [@emilypmendez](https://github.com/emilypmendez) - **Emily Mendez**
- [@darcyclarke](https://github.com/darcyclarke) - **Darcy Clarke**
- [@maddhruv](https://github.com/maddhruv) - **Dhruv Jain**
- [@chowdhurian](https://github.com/chowdhurian) - **Manil Chowdhury**
- [@codeekage](https://github.com/codeekage) - **Agiri Abraham JNR**
- [@add1sun](https://github.com/add1sun) - **Addison Berry**
- [@Qard](https://github.com/Qard) - **Stephen Belanger**
- [@watilde](https://github.com/watilde) - **Daijiro Wachi**
- [@tolmasky](https://github.com/tolmasky) - **Francisco Ryan Tolmasky I**
- [@milapbhojak](https://github.com/milapbhojak) - **Milap Bhojak**
- [@devamaz](https://github.com/devamaz) - **Ahmad Abdul-Aziz**
* [@oe](https://github.com/oe) - **Olivia Hugger**
* [@fhemberger](https://github.com/fhemberger) - **Frederic Hemberger**
* [@bnb](https://github.com/bnb) - **Tierney Cyren**
* [@timothyis](https://github.com/timothyis) - **Timothy**
* [@JonahMoses](https://github.com/JonahMoses) - **Jonah Moses**
* [@amiller-gh](https://github.com/amiller-gh) - **Adam Miller**
* [@emilypmendez](https://github.com/emilypmendez) - **Emily Mendez**
* [@darcyclarke](https://github.com/darcyclarke) - **Darcy Clarke**
* [@maddhruv](https://github.com/maddhruv) - **Dhruv Jain**
* [@chowdhurian](https://github.com/chowdhurian) - **Manil Chowdhury**
* [@codeekage](https://github.com/codeekage) - **Agiri Abraham JNR**
* [@add1sun](https://github.com/add1sun) - **Addison Berry**
* [@Qard](https://github.com/Qard) - **Stephen Belanger**
* [@watilde](https://github.com/watilde) - **Daijiro Wachi**
* [@tolmasky](https://github.com/tolmasky) - **Francisco Ryan Tolmasky I**
* [@milapbhojak](https://github.com/milapbhojak) - **Milap Bhojak**
* [@devamaz](https://github.com/devamaz) - **Ahmad Abdul-Aziz**

##### UI Design and Content Creation

- [@amiller-gh](https://github.com/amiller-gh) - **Adam Miller**
- [@bnb](https://github.com/bnb) - **Tierney Cyren**
- [@codeekage](https://github.com/codeekage) - **Agiri Abraham JNR**
- [@chowdhurian](https://github.com/chowdhurian) - **Manil Chowdhury**
- [@maddhruv](https://github.com/maddhruv) - **Dhruv Jain**
- [@milapbhojak](https://github.com/milapbhojak) - **Milap Bhojak**
- [@tolmasky](https://github.com/tolmasky) - **Francisco Ryan Tolmasky I**
- [@iNidAName](https://github.com/inidaname) - **Hassaan Sani**
- [@abedzantout](https://github.com/abedzantout) - **Abdul Rahman Zantout**
- [@AliObaji](https://github.com/AliObaji) - **Ali Obaji**
- [@AhmadAwais](https://github.com/AhmadAwais) - **AhmadAwais**
* [@amiller-gh](https://github.com/amiller-gh) - **Adam Miller**
* [@bnb](https://github.com/bnb) - **Tierney Cyren**
* [@codeekage](https://github.com/codeekage) - **Agiri Abraham JNR**
* [@chowdhurian](https://github.com/chowdhurian) - **Manil Chowdhury**
* [@maddhruv](https://github.com/maddhruv) - **Dhruv Jain**
* [@milapbhojak](https://github.com/milapbhojak) - **Milap Bhojak**
* [@tolmasky](https://github.com/tolmasky) - **Francisco Ryan Tolmasky I**
* [@iNidAName](https://github.com/inidaname) - **Hassaan Sani**
* [@abedzantout](https://github.com/abedzantout) - **Abdul Rahman Zantout**
* [@AliObaji](https://github.com/AliObaji) - **Ali Obaji**
* [@AhmadAwais](https://github.com/AhmadAwais) - **AhmadAwais**

##### Site Development

- [@abiclub23](https://github.com/abiclub23) - **Abhi Tondepu**
- [@ajay2507](https://github.com/ajay2507) - **Ajaykumar**
- [@connorholyday](https://github.com/connorholyday) - **Connor Holyday**
- [@iceagency-jakecruse](https://github.com/iceagency-jakecruse) - **Jake Cruse**
- [@iceagency-lukehopkins](https://github.com/iceagency-lukehopkins) - **Luke Hopkins**
- [@jestho](https://github.com/jestho) - **Jesper Thøgersen**
- [@jonahmoses](https://github.com/jonahmoses) - **Jonah Moses**
- [@sagirk](https://github.com/sagirk) - **Sagir Khan**
- [@ollelauribostrom](https://github.com/ollelauribostrom) - **Olle Lauri Boström**
- [@belar](https://github.com/Belar) - **Paweł**
- [@erichodges](https://github.com/erichodges) - **Eric Hodges**
- [@utkarshbhimte](https://github.com/utkarshbhimte) - **Utkarsh Bhimte**
- [@lidoravitan](https://github.com/lidoravitan) - **Lidor Avitan**
- [@mbj36](https://github.com/mbj36) - **Mohit Bajoria**
- [@zanmarolt](https://github.com/zanmarolt) - **Zan Marolt**
- [@imbhargav5](https://github.com/imbhargav5) - **Bhargav Ponnapalli**
- [@mikeattara](https://github.com/mikeattara) - **Mike Perry Y Attara**
- [@ZYSzys](https://github.com/ZYSzys) - **ZYSzys**
- [@mrjam2](https://github.com/mrjam2) - **Jamie Burton**
- [@jamesgeorge007](https://github.com/jamesgeorge007) - **James George**
- [@Yash-Handa](https://github.com/Yash-Handa) - **Yash Handa**
- [@iNidAName](https://github.com/inidaname) - **Hassaan Sani**
- [@abedzantout](https://github.com/abedzantout) - **Abdul Rahman Zantout**
- [@LaRuaNa](https://github.com/LaRuaNa) - **Onur Laru**
- [@AhmadAwais](https://github.com/AhmadAwais) - **AhmadAwais**
- [@BeniCheni](https://github.com/BeniCheni) - **Benjamin Chen**
- [@kevjin](https://github.com/kevjin) - **Kevin Jin**
* [@abiclub23](https://github.com/abiclub23) - **Abhi Tondepu**
* [@ajay2507](https://github.com/ajay2507) - **Ajaykumar**
* [@connorholyday](https://github.com/connorholyday) - **Connor Holyday**
* [@iceagency-jakecruse](https://github.com/iceagency-jakecruse) - **Jake Cruse**
* [@iceagency-lukehopkins](https://github.com/iceagency-lukehopkins) - **Luke Hopkins**
* [@jestho](https://github.com/jestho) - **Jesper Thøgersen**
* [@jonahmoses](https://github.com/jonahmoses) - **Jonah Moses**
* [@sagirk](https://github.com/sagirk) - **Sagir Khan**
* [@ollelauribostrom](https://github.com/ollelauribostrom) - **Olle Lauri Boström**
* [@belar](https://github.com/Belar) - **Paweł**
* [@erichodges](https://github.com/erichodges) - **Eric Hodges**
* [@utkarshbhimte](https://github.com/utkarshbhimte) - **Utkarsh Bhimte**
* [@lidoravitan](https://github.com/lidoravitan) - **Lidor Avitan**
* [@mbj36](https://github.com/mbj36) - **Mohit Bajoria**
* [@zanmarolt](https://github.com/zanmarolt) - **Zan Marolt**
* [@imbhargav5](https://github.com/imbhargav5) - **Bhargav Ponnapalli**
* [@mikeattara](https://github.com/mikeattara) - **Mike Perry Y Attara**
* [@ZYSzys](https://github.com/ZYSzys) - **ZYSzys**
* [@mrjam2](https://github.com/mrjam2) - **Jamie Burton**
* [@jamesgeorge007](https://github.com/jamesgeorge007) - **James George**
* [@Yash-Handa](https://github.com/Yash-Handa) - **Yash Handa**
* [@iNidAName](https://github.com/inidaname) - **Hassaan Sani**
* [@abedzantout](https://github.com/abedzantout) - **Abdul Rahman Zantout**
* [@LaRuaNa](https://github.com/LaRuaNa) - **Onur Laru**
* [@AhmadAwais](https://github.com/AhmadAwais) - **AhmadAwais**
* [@BeniCheni](https://github.com/BeniCheni) - **Benjamin Chen**
* [@kevjin](https://github.com/kevjin) - **Kevin Jin**

## Links

Expand Down
34 changes: 17 additions & 17 deletions docs/adr/0000-adopt-decision-records.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Adopt Decision Records for documenting architectural decisions

- Status: Proposed
- Date: 2020-08-27 <!-- optional -->
* Status: Proposed
* Date: 2020-08-27 <!-- optional -->

[Github issue describing potentially adopting decision records](https://github.com/nodejs/nodejs.dev/issues/853)

Expand All @@ -11,35 +11,35 @@ Knowing that architecture discussions often circle over some of the same topics,

## Decision Drivers <!-- optional -->

- Certain discussion points come up again and again
- Some decisions have been made and aren't necessarily worth re-opening
- If there WAS a good reason to re-open any discussion it's helpful to make
* Certain discussion points come up again and again
* Some decisions have been made and aren't necessarily worth re-opening
* If there WAS a good reason to re-open any discussion it's helpful to make
context available.

## Considered Options

- Lightweight Decision Records
- Markdown Decision Records
- Doing nothing...?
* Lightweight Decision Records
* Markdown Decision Records
* Doing nothing...?

## Decision Outcome

- Adopt decision records!
- They will be stored in the `docs/adr` directory as suggested by the madr
* Adopt decision records!
* They will be stored in the `docs/adr` directory as suggested by the madr
documentation

### Positive Consequences <!-- optional -->

- Hopefully it's easier for folks to uncover the reason why previous decisions turned out as they have
- It's useful context for new users and contributors to explore when suggesting changes
-
* Hopefully it's easier for folks to uncover the reason why previous decisions turned out as they have
* It's useful context for new users and contributors to explore when suggesting changes
*

### Negative Consequences <!-- optional -->

- Potentially decision records are a bit heavy to maintain (requiring more documentation than some folks are comfortable with)
-
* Potentially decision records are a bit heavy to maintain (requiring more documentation than some folks are comfortable with)
*

## Links <!-- optional -->

- [About Markdown Architecture Decision Records](https://adr.github.io/madr/)
- [Issue that suggested adopting ADR's](https://github.com/nodejs/nodejs.dev/issues/853)
* [About Markdown Architecture Decision Records](https://adr.github.io/madr/)
* [Issue that suggested adopting ADR's](https://github.com/nodejs/nodejs.dev/issues/853)
56 changes: 28 additions & 28 deletions docs/adr/template.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# \[short title of solved problem and solution\]

- Status: [proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)] <!-- optional -->
- Deciders: \[list everyone involved in the decision\] <!-- optional -->
- Date: \[YYYY-MM-DD when the decision was last updated\] <!-- optional -->
* Status: [proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)] <!-- optional -->
* Deciders: \[list everyone involved in the decision\] <!-- optional -->
* Date: \[YYYY-MM-DD when the decision was last updated\] <!-- optional -->

Technical Story: \[description | ticket/issue URL\] <!-- optional -->

Expand All @@ -12,61 +12,61 @@ Technical Story: \[description | ticket/issue URL\] <!-- optional -->

## Decision Drivers <!-- optional -->

- \[driver 1, e.g., a force, facing concern, …\]
- \[driver 2, e.g., a force, facing concern, …\]
-<!-- numbers of drivers can vary -->
* \[driver 1, e.g., a force, facing concern, …\]
* \[driver 2, e.g., a force, facing concern, …\]
*<!-- numbers of drivers can vary -->

## Considered Options

- \[option 1\]
- \[option 2\]
- \[option 3\]
-<!-- numbers of options can vary -->
* \[option 1\]
* \[option 2\]
* \[option 3\]
*<!-- numbers of options can vary -->

## Decision Outcome

Chosen option: "\[option 1\]", because \[justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | … | comes out best (see below)\].

### Positive Consequences <!-- optional -->

- \[e.g., improvement of quality attribute satisfaction, follow-up decisions required, …\]
-
* \[e.g., improvement of quality attribute satisfaction, follow-up decisions required, …\]
*

### Negative Consequences <!-- optional -->

- \[e.g., compromising quality attribute, follow-up decisions required, …\]
-
* \[e.g., compromising quality attribute, follow-up decisions required, …\]
*

## Pros and Cons of the Options <!-- optional -->

### \[option 1\]

\[example | description | pointer to more information | …\] <!-- optional -->

- Good, because \[argument a\]
- Good, because \[argument b\]
- Bad, because \[argument c\]
-<!-- numbers of pros and cons can vary -->
* Good, because \[argument a\]
* Good, because \[argument b\]
* Bad, because \[argument c\]
*<!-- numbers of pros and cons can vary -->

### \[option 2\]

\[example | description | pointer to more information | …\] <!-- optional -->

- Good, because \[argument a\]
- Good, because \[argument b\]
- Bad, because \[argument c\]
-<!-- numbers of pros and cons can vary -->
* Good, because \[argument a\]
* Good, because \[argument b\]
* Bad, because \[argument c\]
*<!-- numbers of pros and cons can vary -->

### \[option 3\]

\[example | description | pointer to more information | …\] <!-- optional -->

- Good, because \[argument a\]
- Good, because \[argument b\]
- Bad, because \[argument c\]
-<!-- numbers of pros and cons can vary -->
* Good, because \[argument a\]
* Good, because \[argument b\]
* Bad, because \[argument c\]
*<!-- numbers of pros and cons can vary -->

## Links <!-- optional -->

- [Link type](link-to-adr.md) <!-- example: Refined by [ADR-0005](0005-example.md) -->
-<!-- numbers of links can vary -->
* [Link type](link-to-adr.md) <!-- example: Refined by [ADR-0005](0005-example.md) -->
*<!-- numbers of links can vary -->
Loading

0 comments on commit f4fe4ff

Please sign in to comment.