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

Create docs for Gradle Worker API #6016

Merged
merged 1 commit into from
Apr 21, 2023
Merged

Conversation

atulgpt
Copy link
Contributor

@atulgpt atulgpt commented Apr 19, 2023

Fixes #5843


### <a name="gradle-properties">Options for detekt Gradle properties</a>

```groovy
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the doc here

@cortinico
Copy link
Member

We don't need the whole 1.23 docs (those will be cut once we do the stable),
but just the extra page

@codecov
Copy link

codecov bot commented Apr 19, 2023

Codecov Report

Merging #6016 (685f401) into main (6d58918) will increase coverage by 0.02%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##               main    #6016      +/-   ##
============================================
+ Coverage     84.66%   84.68%   +0.02%     
- Complexity     3840     3863      +23     
============================================
  Files           549      550       +1     
  Lines         13071    13115      +44     
  Branches       2305     2313       +8     
============================================
+ Hits          11066    11107      +41     
  Misses          868      868              
- Partials       1137     1140       +3     

see 2 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@cortinico
Copy link
Member

You don't need to create anything for version 1.23.0. Just add your content here: https://github.com/detekt/detekt/blob/main/website/docs/gettingstarted/gradle.mdx

The docs for 1.23 will appear as soon as we cut the release version

@BraisGabin
Copy link
Member

Update them inside website/docs/gettingstarted/gradle.mdx. This way, as soon as we cut a new version, the content inside there will be frozen on the 1.23 version.

@atulgpt
Copy link
Contributor Author

atulgpt commented Apr 20, 2023

Update them inside website/docs/gettingstarted/gradle.mdx. This way, as soon as we cut a new version, the content inside there will be frozen on the 1.23 version.

@BraisGabin / @cortinico done 😅. Thanks for the help

We can optionally also rename the folder versioned_docs to generated_versioned_docs 🙂

@cortinico
Copy link
Member

We can optionally also rename the folder versioned_docs to generated_versioned_docs 🙂

Nope those are not generated. It's a "copy" of the docs as they are once a given version is released. It still allows us to edit versioned docs if we find a problem in a previous version

@BraisGabin BraisGabin added this to the 1.23.0 milestone Apr 20, 2023
@cortinico cortinico changed the title Create docs for version 1.23 Create docs for Gradle Worker API Apr 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs for enabling Worker API in Gradle plugin
3 participants