Skip to content

[doc] Upgrade libraries (bootstrap, fontawesome, jquery, ...)#2795

Merged
oowekyala merged 18 commits into
pmd:pmd/7.0.xfrom
adangel:pmd7-doc-update-deps
Oct 8, 2020
Merged

[doc] Upgrade libraries (bootstrap, fontawesome, jquery, ...)#2795
oowekyala merged 18 commits into
pmd:pmd/7.0.xfrom
adangel:pmd7-doc-update-deps

Conversation

@adangel

@adangel adangel commented Sep 18, 2020

Copy link
Copy Markdown
Member

Describe the PR

As a preparation for the tasks in #1139 this PR updates the used libraries. Hopefully, after this PR is done, it will be easier to upgrade the libraries in the future.

The goal is also, to cleanup the impl at some places. Delete unused stuff (like jekyll includes we never use) and cleanup the js folder and move inline js into files. This is not done yet.

This also removes the never used support for PDF generation. And deletes some left over samples (like tooltips).

Related issues

Ready?

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

These are the minimal needed files from the downloadable archive
fontawesome-free-5.14.0-web.zip

See https://fontawesome.com/how-to-use/on-the-web/setup/hosting-font-awesome-yourself
Note: the css class "fa" is deprecated and "fas" should be used
instead. "fab" is for branding icons (like github).
Also delete some unused includes, such as google_analytics and usermap*
and delete old IE code
@adangel adangel added the in:documentation Affects the documentation [doc] label Sep 18, 2020
@adangel adangel added this to the 7.0.0 milestone Sep 18, 2020
@ghost

ghost commented Sep 18, 2020

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

Generated by 🚫 Danger

@adangel adangel marked this pull request as ready for review September 20, 2020 18:18

@oowekyala oowekyala 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 working on this! I merged back #2785, but I'm not 100% sure I did it right, let me know

Comment thread docs/_includes/google_analytics.html
Comment thread docs/_includes/initialize_shuffle.html
Also remove unnecessary navgoco configuration and hooks.
@adangel

adangel commented Oct 8, 2020

Copy link
Copy Markdown
Member Author

Thanks for working on this! I merged back #2785, but I'm not 100% sure I did it right, let me know

I think, the merge looks good, thanks!
I've found a different small bug with the sidebar, which I've fixed. Now the sidebar is expanded again to the current item by default.

@adangel

adangel commented Oct 8, 2020

Copy link
Copy Markdown
Member Author

Oh, by the way (off topic): I've found an old branch, where I tried to generate a PDF version of the doc: https://github.com/adangel/pmd/tree/pmd7-doc-pdf The generated PDF was about 1000 pages big....
pmd.pdf Maybe something to consider later, very later.

@oowekyala oowekyala 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.

I'm going to merge this now. Thanks for the effort

Oh, by the way (off topic): I've found an old branch, where I tried to generate a PDF version of the doc: https://github.com/adangel/pmd/tree/pmd7-doc-pdf The generated PDF was about 1000 pages big....
pmd.pdf Maybe something to consider later, very later.

Err.. yeah, if there is some demand we can consider it later but I wouldn't bother with that right now. The cleanups of the sources are worthwhile too.

Edit: I really like the new color scheme, kudos

@oowekyala oowekyala merged commit 6bf3fef into pmd:pmd/7.0.x Oct 8, 2020
@adangel adangel deleted the pmd7-doc-update-deps branch October 9, 2020 09:38
@adangel adangel mentioned this pull request Jan 23, 2023
55 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in:documentation Affects the documentation [doc]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants