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

WIKI: clean up #11912

Open
3 tasks done
Rapster opened this issue May 11, 2024 · 16 comments
Open
3 tasks done

WIKI: clean up #11912

Rapster opened this issue May 11, 2024 · 16 comments
Labels
discussion Item needs to be discussed by core devs documentation Documentation needs updating enhancement Additional functionality to current component

Comments

@Rapster
Copy link
Member

Rapster commented May 11, 2024

Description

Wiki pages are bit of a mess:

  • the index page is empty
  • contributing redirect to the contributing.md
  • locales redirects to another page

We should get rid of those last two. The index page could contain the building from source page, maybe more, also some indication per IDE (import settings for intellij, eclipse, vscode) etc.

Describe the solution you would like

something awesome

Additional context

No response

@Rapster Rapster added enhancement Additional functionality to current component documentation Documentation needs updating discussion Item needs to be discussed by core devs labels May 11, 2024
@melloware
Copy link
Member

OK changes made check it out! I also cleaned up and updated the building from Source instructions to use better Markdown formatting.

@Rapster
Copy link
Member Author

Rapster commented May 12, 2024

@melloware don't you think it could be also the right place to display these https://web.archive.org/web/20230606161941/https://jsf.zeef.com/bauke.scholtz# ?

@melloware
Copy link
Member

melloware commented May 12, 2024

Absolutely. That would be awesome. If we could get the real URLs we could do it... the Wayback seems to have messed up some of the URLs? Cc @FlipWarthog

@Rapster
Copy link
Member Author

Rapster commented May 12, 2024

@melloware
Copy link
Member

Awesome. Yep I will work on that this week!

@melloware
Copy link
Member

@FlipWarthog @Rapster heard back from BalusC he had already recreated it here: https://balusc.omnifaces.org/2024/03/jsfzeefcom-is-down.html

@FlipWarthog
Copy link
Contributor

What kind of IDE info are you thinking? I can start working on a VS Code set up guide.

@Rapster
Copy link
Member Author

Rapster commented May 13, 2024

@FlipWarthog @Rapster heard back from BalusC he had already recreated it here: https://balusc.omnifaces.org/2024/03/jsfzeefcom-is-down.html

Perfect!

What kind of IDE info are you thinking? I can start working on a VS Code set up guide.

Something even as a committer I still stuggle with, which is code format... We have checkstyle for eclipse, nothing concrete for Intellij, yet I think it's possible to import eclipse checkstyle in Intellij, I can figure this last one out. No idea about vscode

@FlipWarthog
Copy link
Contributor

Okay, got it. I do have checkstyle working with vscode so I'll throw together a quick setup guide

@FlipWarthog
Copy link
Contributor

Here's what I came up with; most of the heavy lifting was already done in the primefaces-test guide... I realized while I was putting this together that I don't have formatting right for Java files (@melloware I might bug you about this)

Visual Studio Code

Prerequisites (Basic setup)

  1. Complete Buliding Primefaces Snapshots
  2. Complete primefaces-test Visual Studio Code Quickstart

Checkstyle

  1. Download latest Checkstyle jar
    • Path to the JAR will be used later; it's recommended that you move it into your Visual Studio Code directory
    • Note: this is not the same checkstyle JAR that will be in your .m2 repository after building PrimeFaces
  2. Install Checkstyle extension in Visual Studio Code
  3. Enable Checkstyle extension by configuring the following settings:
    "checkstyle.checkstylePath": "C:\\path\\to\\checkstyle-10.16.0-all.jar",
    "checkstyle.configurationPath": "C:\\path\\to\\primefaces-checkout\\primefaces\\conf\\checkstyle.xml",

@Rapster
Copy link
Member Author

Rapster commented May 18, 2024

Looks good, I added a new page (to complete)

@Rapster
Copy link
Member Author

Rapster commented May 20, 2024

@melloware I know we discussed imports in the past, each IDE has their own order... which one should we use? From what I can see, the trend today is either intellij or vscode but I also wonder, regarding the PF community only, what do we use as commiters?

@melloware
Copy link
Member

melloware commented May 20, 2024

@Rapster my personal preference is this order but I can be convinced otherwise

ANY STATIC IMPORT FIRST

java.*

javax.* or jakarta.*

com.*

org.*

@Rapster
Copy link
Member Author

Rapster commented May 20, 2024

My preference is what my IDE does 😅 (I personnaly don't care what the order is...)

IntelliJ looks like this

java.*

javax.* or jakarta.*

OTHERS
OTHER STATIC IMPORTS

@melloware
Copy link
Member

We could use https://code.revelc.net/impsort-maven-plugin/ and take the decision out of everyone's hands?

@melloware
Copy link
Member

@Rapster either way if you document it we can all just set our IDE's the same way but at least we will have documented it :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Item needs to be discussed by core devs documentation Documentation needs updating enhancement Additional functionality to current component
Projects
None yet
Development

No branches or pull requests

3 participants