Format README #408

2023-02-26T15:07:53Z

pat-s commented

2023-02-26 15:07:53 +00:00

(Migrated from gitea.com)

Some small formatting changes which are auto-applied by the markdown code styler in vscode (which I am using a lot).

These are also present in #407.
Merging this before/in general would help be a bit when tinkering with the README.
Mainly indentation related, plus some single quotes -> double quotes changes.

Some small formatting changes which are auto-applied by the markdown code styler in vscode (which I am using a lot). These are also present in #407. Merging this before/in general would help be a bit when tinkering with the README. Mainly indentation related, plus some single quotes -> double quotes changes.

justusbunsi (Migrated from gitea.com) reviewed 2023-02-26 15:08:01 +00:00

justusbunsi commented

2023-02-26 15:27:30 +00:00

(Migrated from gitea.com)

Everything that can be covered by Markdownlint should be configured there. Otherwise, changing the README will be a mess when using different IDEs.

https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md

If we commit on using such VSCode plugin, it can be mentioned within CONTRIBUTING.md along with the already recommended VSCode plugins.

Everything that can be covered by Markdownlint should be configured there. Otherwise, changing the README will be a mess when using different IDEs. https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md If we commit on using such VSCode plugin, it can be mentioned within CONTRIBUTING.md along with the already recommended VSCode plugins.

pat-s commented

2023-03-06 09:37:34 +00:00

(Migrated from gitea.com)

Everything that can be covered by Markdownlint should be configured there. Otherwise, changing the README will be a mess when using different IDEs.

I haven't found a way in markdownlint to address the multiline-quote thingy you see in the diff of this PR.

Same for the double quotes/single quotes change (even though I think this must be configurable somehow).

WRT to the indentation changes: I think the current README format is off for all the changes proposed in the PR, e.g. the mysql: and postgresql: keys are top-level in valuyes.yaml and should not have indentation in the README.

To make things more strict, I also added an .editorconfig file even though this does not have direct influence on the README changes here.

One things is certainly to catch such offsets in CI, the other thing is to get README.md into a "proper" state for the moment :)

> Everything that can be covered by Markdownlint should be configured there. Otherwise, changing the README will be a mess when using different IDEs. I haven't found a way in markdownlint to address the multiline-quote thingy you see in the diff of this PR. Same for the double quotes/single quotes change (even though I think this must be configurable somehow). WRT to the indentation changes: I think the current README format is off for all the changes proposed in the PR, e.g. the `mysql:` and `postgresql:` keys are top-level in `valuyes.yaml` and should not have indentation in the README. To make things more strict, I also added an `.editorconfig` file even though this does not have direct influence on the README changes here. One things is certainly to catch such offsets in CI, the other thing is to get README.md into a "proper" state for the moment :)

justusbunsi commented

2023-03-06 11:36:09 +00:00

(Migrated from gitea.com)

Adding the editorconfig ist a great idea.

I've just seen the "tab for every file" as indent. This won't work for yaml files. We should use spaces in editorconfig instead.

Adding the editorconfig ist a great idea. I've just seen the "tab for every file" as indent. This won't work for yaml files. We should use spaces in editorconfig instead.

pat-s commented

2023-03-06 19:19:45 +00:00

(Migrated from gitea.com)

I've just seen the "tab for every file" as indent. This won't work for yaml files. We should use spaces in editorconfig instead.

Good catch, that was a mistake by my side, I am also in favor of spaces.

> I've just seen the "tab for every file" as indent. This won't work for yaml files. We should use spaces in editorconfig instead. Good catch, that was a mistake by my side, I am also in favor of spaces.

lunny (Migrated from gitea.com) approved these changes 2023-03-07 13:38:14 +00:00

justusbunsi commented

2023-03-07 15:21:52 +00:00

(Migrated from gitea.com)

@pat-s Which Vscode plugin do you use that formatted the markdown file? It can be mentioned within CONTRIBUTING.md along with the already recommended VSCode plugins.

Otherwise lgtm

@pat-s Which Vscode plugin do you use that formatted the markdown file? It can be mentioned within CONTRIBUTING.md along with the already recommended VSCode plugins. Otherwise lgtm

pat-s commented

2023-03-07 17:05:56 +00:00

(Migrated from gitea.com)

I am using https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode but there are tons of markdown formatters out there.

But yeah let's add it to the list in CONTRIBUTING.md!

I am using https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode but there are tons of markdown formatters out there. But yeah let's add it to the list in CONTRIBUTING.md!

techknowlogick (Migrated from gitea.com) approved these changes 2023-03-07 19:50:17 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: lunny/helm-chart#408