Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[documentation] Ktlint site installation instructions #2256

Closed
binkley opened this issue Sep 10, 2023 · 1 comment · Fixed by #2267
Closed

[documentation] Ktlint site installation instructions #2256

binkley opened this issue Sep 10, 2023 · 1 comment · Fixed by #2267

Comments

@binkley
Copy link

binkley commented Sep 10, 2023

I'm trying "bug" but perhaps this is "enhancement".

I see the announcement of 1.0.0 release of ktlint (https://github.com/pinterest/ktlint/releases/tag/1.0.0)
My current Maven builds use 2.0.0 for ktlint-maven-plugin from GantSign (John Freeman - @freemanjp).

Perhaps the GitHub README.md and the Ktlint site might give some prominent quick "getting started" instructions at the top when devs land on these pages?
(Ktlint site has a side bar that leads to instructions, but a prominent link or "getting started" would answer the first question all devs have.)

You might also consider pointing folks to the Maven plugin for those folks using Maven, in addition to the Ant instructions. Something like you do for Gradle with @JLLeitschuh plugin.

@paul-dingemans
Copy link
Collaborator

README.md and home page should contain links to:

For third party integration not detailed instruction are added as we are not in control of those integrations. So only a link to the documentation of the integration is allowed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants