WrenSecurity / wrensec-commons

Community fork of ForgeRock Commons, which contains common utility code used by multiple products originally developed by ForgeRock.
http://wrensecurity.org
0 stars 10 forks source link

Improve generated site structure and content #53

Open pavelhoral opened 6 months ago

pavelhoral commented 6 months ago

Current state

Wrensec Commons is an umbrella project with a set of more or less independent libraries (e.g. HTTP Framework, I18N Framework, Audit Framework, ...). Having a single project makes the project management, project maintenance and shared dependency management easier.

I recently "revived" the project's Maven site and set it up to be published at https://wrensecurity.github.io/wrensec-commons/. This allows us to have readily available public documentation that we can browse and link to as needed. Wrensec Commons is not a "first-class citizen" when it comes to projects we want to have featured on the official website https://wrensecurity.org site, so the Maven site serves as the primary webpage.

Overall target

I have only worked with the top-level parent module, so the Maven sites for individual projects are a mixture of vanilla Maven sites and legacy content that we have not been forced to remove due to license conflicts. I would like to see child projects "revived" in the same way so that the overall Maven site structure is clean and consistent with meaningful content that can serve as a place that can be maintained and expanded with additional content in the future.

Proposed changes

I want to go through every single project (direct descendants of the parent module) and "revive" their Maven sites. Each individual project should have a meaningful Maven site on its own and the parent project should provide an overall project overview with links to the individual project Maven sites.

Inspiration can be drawn out from Apache HTTP Components site https://hc.apache.org/httpcomponents-client-5.3.x/index.html and https://commons.apache.org/ (would be nice to have few additional examples).

Breaking down into tasks:

I am sure other tasks will present themselves when we start working on this.