Skip to content

[doc] Improve "Edit me on github" button#3811

Merged
adangel merged 6 commits into
pmd:masterfrom
btjiong:issue2504-editme-button
Mar 24, 2022
Merged

[doc] Improve "Edit me on github" button#3811
adangel merged 6 commits into
pmd:masterfrom
btjiong:issue2504-editme-button

Conversation

@btjiong

@btjiong btjiong commented Feb 25, 2022

Copy link
Copy Markdown
Contributor

Describe the PR

  • Added the button at the bottom with some more explaining text
  • Added a smaller button in the section heading line of each section
  • Removed references to the sourceforge forum

I was not sure to which headers the small button should be added. For now I added it only to h2 headers.

This is my first contribution to an open-source project, so feedback is more than welcome!

Related issues

Ready?

  • Added unit tests for fixed bug/feature
  • Passing all unit tests
  • Complete build ./mvnw clean verify passes (checked automatically by github actions)
  • Added (in-code) documentation (if needed)

@adangel adangel added this to the 6.44.0 milestone Feb 26, 2022
adangel
adangel reviewed Feb 26, 2022
View reviewed changes

@adangel adangel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks, looks good so far. I'll have a closer look next week.

@ghost

ghost commented Feb 26, 2022

Copy link
Copy Markdown
1 Message
📖 No java rules are changed!

Generated by 🚫 Danger

@adangel adangel self-requested a review February 28, 2022 19:01
adangel
adangel reviewed Mar 3, 2022
View reviewed changes

@adangel adangel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for your PR!

I had a closer look and found some things, I'd like to have changed - sorry, if I'm a bit picky here.

Btw. - when changing something on a software that has a visual change (such as style/layout of a web page), screenshots help a lot...

Comment thread docs/_layouts/page.html Outdated
Comment thread docs/_layouts/page.html Outdated
Comment thread docs/_layouts/page.html Outdated
Comment thread docs/css/customstyles.css Outdated
@btjiong

btjiong commented Mar 3, 2022

Copy link
Copy Markdown
Contributor Author

Thanks for your PR!

I had a closer look and found some things, I'd like to have changed - sorry, if I'm a bit picky here.

Btw. - when changing something on a software that has a visual change (such as style/layout of a web page), screenshots help a lot...

Thanks for the feedback, I will update the requested changes.

@adangel adangel self-requested a review March 22, 2022 19:06
@adangel
[doc] Minor fixes (styling mostly)
af9547a 
Don't show edit buttons for generated pages
adangel
adangel approved these changes Mar 24, 2022
View reviewed changes

@adangel adangel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks, looks good!

I've done some minor tweaks, so my comments are just informational.

Comment thread docs/_includes/footer.html Outdated
Comment thread docs/_includes/header.html Outdated
Comment thread docs/_includes/header.html Outdated
Comment thread docs/_layouts/default.html
Comment thread docs/js/customscripts.js Outdated
@adangel adangel mentioned this pull request Mar 24, 2022
Closed
13 tasks
adangel added a commit that referenced this pull request Mar 24, 2022
@adangel
[doc] Update release notes (#2504, #3811]
857f9b5
adangel added a commit that referenced this pull request Mar 24, 2022
@adangel
Merge pull request #3811 from btjiong:issue2504-editme-button
3d72a0d 
[doc] Improve "Edit me on github" button #3811
@adangel adangel merged commit 698b49d into pmd:master Mar 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@adangel adangel adangel approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

6.44.0

Development

Successfully merging this pull request may close these issues.

[doc] Improve "Edit me on github" button

2 participants

@btjiong @adangel