doc: consistent unordered list style

[nschonni]

Checklist

• make -j4 test (UNIX), or vcbuild test (Windows) passes
• tests and/or benchmarks are included
• documentation is changed or added
• commit message follows commit guidelines

[trivikr]

Is there a preference for using * over -?

Prettier, a popular code formatter uses - over * as shows below:

> cat > test.md
Test
* One
* Two       
^C
> npx prettier test.md
Test

- One
- Two

[nschonni]

I actually prefer - 😄 , I was just going by what looked like the more used format

[trivikr]

I was just going by what looked like the more used format

Some results from grep in node repo:

> grep -r --include=\*.md '^* ' ./ | wc -l
   46352
> grep -r --include=\*.md '^\- ' ./ | wc -l
    6176

* is definitely more popular than - for first level of indentation

[trivikr]

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3902/

[nschonni]

This can be enforced with https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-ordered-list-marker-style afterwards

[Trott]

This PR accidentally altered YAML front-matter, breaking make doc.

It seems like an awfully big change set (1943 changed lines in its current form) and there might be other issues in there like this. I kind of doubt anyone actually reviewed all the changes here and instead rubber-stamped it. I'm not sure we should do it. It seems like we're doing it to be consistent for the sake of being consistent, which isn't terrible or anything, but it doesn't seem that using * in one file and - in another file is actually causing any issues for anyone. (Correction on that welcome.)

If it's possible to set the linter so that it requires one or the other in each file, but rejecting a mixture of both in a single file, that might be an acceptable first step towards eventually making them all consistent.

I'm not going to block this but I'm kind of -0 on it.

[nschonni]

This PR accidentally altered YAML front-matter, breaking make doc.

Thanks, I'll take a look at that

If it's possible to set the linter so that it requires one or the other in each file, but rejecting a mixture of both in a single file, that might be an acceptable first step towards eventually making them all consistent.

Most of the changed files were because they were mixed

it doesn't seem that using * in one file and - in another file is actually causing any issues for anyone. (Correction on that welcome.)

Nope, different across docs is fine. The only issue that can really arise from mixed is if they are accidentally used at the same level, then multiple unorded lists are created. Can't recall if I actually saw any in here

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/25459/

[Trott]

make doc still failing because this PR still modifies YAML in a way that makes it invalid.

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/25461/

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/25463/

[Trott]

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3909/

[Trott]

Landed in e2dcbf1

[nschonni]

Thanks, I'll look at adding that to the remark-lint config if you don't get to it first