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

Remove unused resources from the website #3226

Merged

Conversation

cortinico
Copy link
Member

I noticed that we do have a lot of resources inside the docs/ folder that are unused and that gets published on the website. E.g. https://detekt.github.io/detekt/docker-compose.yml

I suspect we're not using them so I'm cleaning up the folder with all the stuff we don't need.

@codecov
Copy link

codecov bot commented Nov 11, 2020

Codecov Report

Merging #3226 (8ff5490) into master (cd659ce) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #3226   +/-   ##
=========================================
  Coverage     80.10%   80.10%           
  Complexity     2647     2647           
=========================================
  Files           440      440           
  Lines          8013     8013           
  Branches       1529     1529           
=========================================
  Hits           6419     6419           
  Misses          775      775           
  Partials        819      819           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cd659ce...8ff5490. Read the comment docs.

Copy link
Member

@BraisGabin BraisGabin left a comment

Choose a reason for hiding this comment

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

I'm thinking... Now we can use any jekyll plugin, right? So we can have tabs for the different gradle dsls so our doc is a bit less verbose.

@cortinico
Copy link
Member Author

I'm thinking... Now we can use any jekyll plugin, right? So we can have tabs for the different gradle dsls so our doc is a bit less verbose.

True. However while looking at the website I realised we used this theme, that already has support for that tabbed layouts: https://idratherbewriting.com/documentation-theme-jekyll/mydoc_navtabs.html

@BraisGabin
Copy link
Member

Good to know. But, do we want html in our documentation? The other option is this: https://github.com/detekt/detekt/pull/2934/files#diff-3213dd73753b7a82d708ad93393cc0bd16cc1d406339419751c28948b8b78f37

@cortinico
Copy link
Member Author

t html in our documentation? The other option is this: #2934 (files)

Yeah jekyll-code-tabs is probably better than raw HTML

@cortinico cortinico merged commit 11dbe8d into detekt:master Nov 12, 2020
@cortinico cortinico deleted the nc/cleanup-unused-website-resources branch November 12, 2020 14:53
@arturbosch arturbosch added the housekeeping Marker for housekeeping tasks and refactorings label Nov 12, 2020
@arturbosch arturbosch added this to the 1.15.0 milestone Nov 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation housekeeping Marker for housekeeping tasks and refactorings
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants