feat/markdownlint #200

2021-06-30T19:33:24Z

volker.raschek commented

2021-06-30 19:33:24 +00:00

(Migrated from gitea.com)

Hi,
this patch contains a markdownlinter. I think this has the advantage that all users stick to the same format and the README.md follows a consistent structure.

The markdownlinter can be configured via the .markdownlint.yaml file. All possible options are here documented.

I have created the initialie configuration. However, can be adapted to suggestions for change. Has of course the consequence that if necessary the README.md would have to be adapted. I have formatted this in advance according to the defined rules.

For users which use visual-code as IDE is additionally a plugin available.

Hi, this patch contains a markdownlinter. I think this has the advantage that all users stick to the same format and the `README.md` follows a consistent structure. The markdownlinter can be configured via the `.markdownlint.yaml` file. All possible options are [here](https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml) documented. I have created the initialie configuration. However, can be adapted to suggestions for change. Has of course the consequence that if necessary the `README.md` would have to be adapted. I have formatted this in advance according to the defined rules. For users which use visual-code as IDE is additionally a plugin [available](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint).

👍 1

justusbunsi commented

2021-06-30 19:54:13 +00:00

(Migrated from gitea.com)

? This is going to be awesome once finished. Thank you for your invested time so far.

volker.raschek commented

2021-06-30 20:00:20 +00:00

(Migrated from gitea.com)

Hi @justusbunsi,
can you mark this PR as dependency of #176? Otherwise I must revert my changes inside the README.md file.

Furthermore I tried to start the container. However, the pipeline always breaks. I guess that the drone instance has no x86_64 build node?

Hi @justusbunsi, can you mark this PR as dependency of #176? Otherwise I must revert my changes inside the `README.md` file. Furthermore I tried to start the container. However, the pipeline always breaks. I guess that the drone instance has no x86_64 build node?

justusbunsi commented

2021-06-30 20:30:27 +00:00

(Migrated from gitea.com)

Yes, I'll add the dependency on thursday. Right now I'm writing with the app.
Shall I add #196 as dependency as well?

Aside that, please ensure that Gitea is spelled Gitea with a capital G at the beginning since this is the official spelling. ?

Yes, I'll add the dependency on thursday. Right now I'm writing with the app. Shall I add #196 as dependency as well? Aside that, please ensure that Gitea is spelled `Gitea` with a capital G at the beginning since this is the official spelling. ?

justusbunsi commented

2021-10-08 14:23:14 +00:00

(Migrated from gitea.com)

@volker.raschek Could you please resolve the conflicts? What's the status of this PR?

volker.raschek commented

2021-10-08 14:35:08 +00:00

(Migrated from gitea.com)

Hi @justusbunsi,
the problem is, that in your CI are only arm64 nodes available. I tried first to build an image for arm with my raspberry pi, but the image is not arm64, but arm. I think in two weeks I can provide an arm64 based image to get running the CI.

Hi @justusbunsi, the problem is, that in your CI are only arm64 nodes available. I tried first to build an image for arm with my raspberry pi, but the image is not arm64, but arm. I think in two weeks I can provide an arm64 based image to get running the CI.

volker.raschek commented

2021-10-23 14:39:38 +00:00

(Migrated from gitea.com)

Hi @justusbunsi,
I uploaded an arm64 image of markdownlint and the CI works now correctly.

Please do a review.

Volker

Hi @justusbunsi, I uploaded an arm64 image of markdownlint and the CI works now correctly. Please do a review. Volker

lunny (Migrated from gitea.com) reviewed 2021-10-24 08:03:16 +00:00

volker.raschek commented

2021-10-24 08:13:57 +00:00

(Migrated from gitea.com)

Hi @lunny,

that was not intentional. The lines were probably lost during the rebase. I have adapted the README.md accordingly.

Hi @lunny, that was not intentional. The lines were probably lost during the rebase. I have adapted the README.md accordingly.

lunny (Migrated from gitea.com) approved these changes 2021-10-24 08:26:06 +00:00

pat-s (Migrated from gitea.com) approved these changes 2021-11-02 10:55:37 +00:00

pat-s (Migrated from gitea.com) left a comment

Thanks, LGTM! This could also be added to the main Gitea repo.

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: lunny/helm-chart#200