gitea/helm-chart
45
55
Fork 125
Code Issues 32 Pull Requests 8 Actions Releases 87 Activity

Format README #408

Merged
techknowlogick merged 4 commits from format-readme into main 2023-03-07 19:50:40 +00:00
Conversation 6 Commits 4 Files Changed 3 +55 -42
pat-s commented 2023-02-26 15:07:53 +00:00
Member
Copy Link

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.
pat-s added 1 commit 2023-02-26 15:07:54 +00:00
format readme
All checks were successful
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/pr Build is passing
Details
1fd5149723
pat-s requested review from justusbunsi 2023-02-26 15:08:01 +00:00
justusbunsi commented 2023-02-26 15:27:30 +00:00
Member
Copy Link

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 added 1 commit 2023-03-06 09:37:25 +00:00
add editorconfig
All checks were successful
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/pr Build is passing
Details
0a676a8ddd
pat-s commented 2023-03-06 09:37:34 +00:00
Author
Member
Copy Link

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
Member
Copy Link

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 added 1 commit 2023-03-06 19:19:26 +00:00
space
All checks were successful
continuous-integration/drone/pr Build is passing
Details
continuous-integration/drone/push Build is passing
Details
427c7807c8
pat-s commented 2023-03-06 19:19:45 +00:00
Author
Member
Copy Link

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 approved these changes 2023-03-07 13:38:14 +00:00
justusbunsi commented 2023-03-07 15:21:52 +00:00
Member
Copy Link

@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
Author
Member
Copy Link

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!
pat-s added 1 commit 2023-03-07 17:06:47 +00:00
add prettier
All checks were successful
continuous-integration/drone/pr Build is passing
Details
continuous-integration/drone/push Build is passing
Details
7509dabd35
techknowlogick approved these changes 2023-03-07 19:50:17 +00:00
techknowlogick merged commit c46bf7c60f into main 2023-03-07 19:50:40 +00:00
techknowlogick deleted branch format-readme 2023-03-07 19:50:40 +00:00
techknowlogick referenced this issue from a commit 2023-03-07 19:50:41 +00:00
Format README (#408)
Sign in to join this conversation.
Reviewers
No reviewers
justusbunsi
lunny
techknowlogick
Labels
Clear labels   
has
backport

  
in progress

   
invalid
  
kind
breaking

  
kind
bug

  
kind
build

  
kind
dependency

  
kind
deployment

  
kind
docs

  
kind
enhancement

  
kind
feature

  
kind
lint

  
kind
proposal

  
kind
question

  
kind
refactor

  
kind
security

  
kind
testing

  
kind
translation

  
kind
ui

  
need
backport

  
priority
critical

  
priority
low

  
priority
maybe

  
priority
medium

  
reviewed
duplicate

  
reviewed
invalid

  
reviewed
wontfix

  
skip-changelog
  
status
blocked

  
status
needs-feedback

  
status
needs-reviews

  
status
wip

  
upstream
gitea

  
upstream
other

No Label
has
backport
in progress
invalid
kind
breaking
kind
bug
kind
build
kind
dependency
kind
deployment
kind
docs
kind
enhancement
kind
feature
kind
lint
kind
proposal
kind
question
kind
refactor
kind
security
kind
testing
kind
translation
kind
ui
need
backport
priority
critical
priority
low
priority
maybe
priority
medium
reviewed
duplicate
reviewed
invalid
reviewed
wontfix
skip-changelog
status
blocked
status
needs-feedback
status
needs-reviews
status
wip
upstream
gitea
upstream
other
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
4 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: gitea/helm-chart#408
No description provided.
Delete Branch "format-readme"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?