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

[doc] Improve Codacy description #1357

Merged
merged 5 commits into from Sep 25, 2018

Conversation

Projects
None yet
3 participants
@DReigada
Contributor

DReigada commented Sep 24, 2018

  • The PR is submitted against master. The PMD team will merge back to support branches as needed.
  • ./mvnw test passes.
  • ./mvnw pmd:check passes.
  • ./mvnw checkstyle:check passes.

PR Description:
Add automated code review section to tools page and improve Codacy description

DReigada added some commits Sep 24, 2018

* GUIs

## Automated Code Review

This comment has been minimized.

@DReigada

DReigada Sep 24, 2018

Contributor

Should I also add a "Summary" table here, like the one in "IDE Integrations"?

This comment has been minimized.

@adangel

adangel Sep 24, 2018

Member

I think, a summary table is not needed, since we have only one entry here - codacy.
However, I'd move up the detailed info from the table below and provide it here, e.g. at the end of the paragraph as a bullet point list (homepage, sourcecode, maintainers).

This comment has been minimized.

@DReigada

DReigada Sep 25, 2018

Contributor

Fixed!

@DReigada DReigada changed the title from *[docs]* Improve Codacy description to [docs] Improve Codacy description Sep 24, 2018

@pmd-test

This comment has been minimized.

pmd-test commented Sep 24, 2018

1 Message
📖 No java rules are changed!

Generated by 🚫 Danger

@adangel

Thanks fro the PR!
Could you please move up the entry from the summary table to the codacy paragraph and remove the manual bullet point TOC at the beginning? Thanks!

* GUIs

## Automated Code Review

This comment has been minimized.

@adangel

adangel Sep 24, 2018

Member

I think, a summary table is not needed, since we have only one entry here - codacy.
However, I'd move up the detailed info from the table below and provide it here, e.g. at the end of the paragraph as a bullet point list (homepage, sourcecode, maintainers).

@@ -6,11 +6,19 @@ permalink: pmd_userdocs_tools.html
author: David Dixon-Peugh <dpeugh@users.sourceforge.net>
---

* IDE plugins
* [Continuous Integrations plugins](/pmd_userdocs_ci.html)

This comment has been minimized.

@adangel

adangel Sep 24, 2018

Member

The link was actually meant to point to /pmd_userdocs_tools_ci.html (e.g. https://pmd.github.io/pmd-6.7.0/pmd_userdocs_tools_ci.html).

As there is a TOC automatically created (see https://pmd.github.io/pmd-6.7.0/pmd_userdocs_tools.html), we probably don't need the list here at all.
I think, we should just remove it entirely. The CI plugins page is also visible in the menu on the left, so no need to add a link here additionally.

Since we don't have any content for GUIs, let's just remove this as well.

This comment has been minimized.

@DReigada

DReigada Sep 25, 2018

Contributor

Fixed!

DReigada added some commits Sep 25, 2018

@DReigada

This comment has been minimized.

Contributor

DReigada commented Sep 25, 2018

Thanks for the feedback @adangel!
Just pushed the changes you requested

@adangel

Awesome, thanks!

@adangel adangel changed the title from [docs] Improve Codacy description to [doc] Improve Codacy description Sep 25, 2018

@adangel adangel added this to the 6.8.0 milestone Sep 25, 2018

@adangel adangel merged commit 1671046 into pmd:master Sep 25, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

adangel added a commit that referenced this pull request Sep 25, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment