Use markdown-cli to check markdown for the style errors

[mathbunnyru]

No description provided.

[mathbunnyru]

This fixes some errors in an automatic way.

[mathbunnyru]

This is better to be fixed in a separate PR (it will be too much noise here)

[consideRatio]

This LGTM!

I have become very fond of an autoformatter for markdown called prettier, but I have no experience with markdown-cli to compare it with. Due to that, I suggest that deliberating on that isn't a blocker for merging this PR. Briefly though, we have used prettier across the jupyterhub organization for YAML, JSON, and Markdown autoformatting - here is an example from a .pre-commit-config.yml:

  # Autoformat: markdown, yaml
  - repo: https://github.com/pre-commit/mirrors-prettier
    rev: v2.2.1
    hooks:
      - id: prettier

[mathbunnyru]

This LGTM!

I have become very fond of an autoformatter for markdown called prettier, but I have no experience with markdown-cli to compare it with. Due to that, I suggest that deliberating on that isn't a blocker for merging this PR. Briefly though, we have used prettier across the jupyterhub organization for YAML, JSON, and Markdown autoformatting - here is an example from a .pre-commit-config.yml:

  # Autoformat: markdown, yaml
  - repo: https://github.com/pre-commit/mirrors-prettier
    rev: v2.2.1
    hooks:
      - id: prettier

Thanks, @consideRatio. Prettier looks nice. I will take a closer look after this PR gets merged.

[mathbunnyru]

@romainx could you please take a look here?

Also, I had one approval from @consideRatio, which makes me believe that this is ready to be merged :)

[mathbunnyru]

The reason I'm asking - this blocks me from further docs improvement (from the technical point of view).

[romainx]

@mathbunnyru there is a conflict now could you solve it?
Any advice on how to review all the changes to the docs?
I guess generate the doc locally and check?

[consideRatio]

Any advice on how to review all the changes to the docs?
I guess generate the doc locally and check?

RTD pr preview would be nice to activate, requires maintainer permissions on the associated RTD project though.

@parente @minrk @willingc
could you add @romainx and @mathbunnyru who is a maintainer / about to be (#1276) of this project to the RTD project?

https://readthedocs.org/projects/jupyter-docker-stacks/

[mathbunnyru]

@mathbunnyru there is a conflict now could you solve it?

Fixed.

Any advice on how to review all the changes to the docs?
I guess generate the doc locally and check?

Yes, for now local generation (though we need to use old versions).
Or, just check that the syntax is correct, it should work fine :)

RTD pr preview would be great 👍

[consideRatio]

@mathbunnyru and @romainx I don't remember how it works properly, but perhaps you can make sure you have a RTD account (or have signed in once using your github handle to RTD)?

[mathbunnyru]

@mathbunnyru and @romainx I don't remember how it works properly, but perhaps you can make sure you have a RTD account (or have signed in once using your github handle to RTD)?

I've already created one and linked it with my GitHub account and the login is the same mathbunnyru.
So, waiting for someone to give me some rights :)

[romainx]

@consideRatio same for me.

[romainx]

Finally I reviewed the files manually 😅. Did not catch any error 🕵️ .

[romainx]

Thanks @mathbunnyru always improve!