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

[doc] Improve documentation about the available renderers (PMD/CPD) #2413

Merged
merged 5 commits into from
Apr 20, 2020

Conversation

adangel
Copy link
Member

@adangel adangel commented Apr 11, 2020

PR Description:

  • CPD has an own subsection now
  • Extra page for CPD's renderers
  • Extra page for PMD's renderers including examples

Note: while the CPD page is moved in the sidebar, the permalink stays the same.

@adangel adangel added the in:documentation Affects the documentation label Apr 11, 2020
@adangel adangel added this to the 6.23.0 milestone Apr 11, 2020
@pmd-test
Copy link

pmd-test commented Apr 11, 2020

1 Message
📖 This changeset introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Full report
This changeset introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Full report

Generated by 🚫 Danger

@adangel adangel changed the title [doc] Improve documentation about the available renderer (PMD/CPD) [doc] Improve documentation about the available renderers (PMD/CPD) Apr 13, 2020
@adangel adangel mentioned this pull request Apr 13, 2020
2 tasks
oowekyala added a commit to adangel/pmd that referenced this pull request Apr 20, 2020
Copy link
Member

@oowekyala oowekyala left a comment

Choose a reason for hiding this comment

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

Thanks! I'll merge this before #2414 and #2404 so that those can update the new page too

Also, there wasn't an issue ticket to begin with, but maybe we can add PRs like this directly to the list of "fixed issues" in the release notes. It describes and fixes an issue at the same time

oowekyala added a commit that referenced this pull request Apr 20, 2020
@oowekyala oowekyala merged commit a007b0b into pmd:master Apr 20, 2020
@adangel
Copy link
Member Author

adangel commented Apr 23, 2020

Also, there wasn't an issue ticket to begin with, but maybe we can add PRs like this directly to the list of "fixed issues" in the release notes. It describes and fixes an issue at the same time

Sounds good. I sometimes did this before as well. The only thing I'm unsure about is: when to add an entry to the release notes? If it's an issue, that is fixed - always - that's easy to decide. Simple rule. But for pull requests, there is no such simple rule... but we can try to do this in the future. For external PRs we might need to mention it twice in the release notes (under fixed issues and under external contributions).

@adangel adangel deleted the doc-renderer branch April 23, 2020 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in:documentation Affects the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants