Gather projects that publish content under wildfly.github.io

[jmesnil]

http://wildfly.github.io is using the custom domain name docs.wildfly.org to expose content related to WildFly.

There are multiple projects under the https://github.com/wildfly organization that uses this domain.

Projects that publish content under docs.wildfly.org

• wildfly/wildfly
  • generate docs from its docs directory that is copied in this wildfly/wildfly.github.io repo manually
  • does not use GitHub pages
  • published at https://docs.wildfly.org
  • https://github.com/wildfly/wildfly "owns" the root directory of https://docs.wildfly.org
• wildfly/wildfly-maven-plugin
  • use GitHub pages to publish generated plugin documentation
  • published at https://docs.wildfly.org/wildfly-maven-plugin/
• wildfly/galleon-plugins
  • generate docs from its docs directory that is copied in this wildfly/wildfly.github.io repo manually
  • does not use GitHub pages
  • published at https://docs.wildfly.org/galleon-plugins/
• wildfly/wildfly-charts/
  • use GitHub pages to generate the Helm Chart repository catalog
  • published at https://docs.wildfly.org/wildfly-charts/
• wildfly/wildfly-common
  • use GitHub pages to publish its javadoc
  • published at http://docs.wildfly.org/wildfly-common/
• wildfly/wildfly-client-config
  • use GitHub pages to publish its javadoc
  • published at http://docs.wildfly.org/wildfly-client-config/
• wildfly/galleon
  • generate docs from its docs directory that is copied in this wildfly/wildfly.github.io repo manually
  • does not use GitHub pages
  • published at https://docs.wildfly.org/galleon
• wildfly/wildfly-operator
  • use GitHub pages to publish its generated documentation
  • published at https://docs.wildfly.org/wildfly-operator/
• wildfly/wildfly-proposals
  • all proposals for new WildFly features are documented in asciidoc
  • published at https://docs.wildfly.org/wildfly-proposals
• wildfly/wildfly-capabilities
  • the capabilities registered in WildFly are documented in asciidoc
  • published at https://docs.wildfly.org/wildfly-capabilities

Projects that publish content under www.wildfly.org

• wildfly/wildfly.org/
  • using a custom domain to publish at https://www.wildfly.org/
  • also available at https://docs.wildfly.org/wildfly.org/

Potential projects that could publish content

• wildfly/certifications
  • evidences of TCK certifications for WildFly releases

Projects outside of wildfly organization that publish their content under docs.wildfly.org

• wildfly-extras/wildfly-jar-maven-plugin
  • generate docs from its docs directory that is copied in this wildfly/wildfly.github.io repo manually
  • does not use GitHub pages
  • published at https://docs.wildfly.org/bootablejar/

[spyrkob]

@jmesnil I'm not sure if that's a correct issue, but it would be great if we could publish wildfly-extras/wildfly-channels and wildfly-extras/prospero docs under docs.wildfly.org as well

[jamezp]

@spyrkob It seems like the correct issue to as the wildfly-jar-maven-plugin is listed here as well. How we go about adding a different repository here, I'm not too sure about.

I suppose one option might be to have a simple landing page at docs.wildfly.org/wildfly-extras. Though maybe that doesn't make sense either. Or we create the repository and do redirects to wildfly-extras.github.io/project-name.

[bstansberry]

To publish wildfly/certifications we'd need to reorganize it to not use a branch per specification. @scottmarlow fyi

[jamezp]

To publish wildfly/certifications we'd need to reorganize it to not use a branch per specification. @scottmarlow fyi

Somewhat thinking out loud here, but I we might be able to generate some kind of index page based on tags which would likely be better than branches.

[bstansberry]

Others:

https://github.com/wildfly-extras/wildfly-datasources-galleon-pack (has a doc dir)
https://github.com/wildfly-extras/wildfly-myfaces-feature-pack
https://github.com/wildfly-extras/wildfly-graphql-feature-pack
https://github.com/wildfly-extras/wildfly-grpc-feature-pack (has a docs dir)
https://github.com/wildfly-extras/wildfly-cloud-galleon-pack (has a doc dir)
https://github.com/wildfly-extras/deployment-transformer-feature-pack

[jmesnil]

There are a lot of projects in https://github.com/wildfly-extras/ that would benefit from publishing their docs.

Having them to manually sync to this repository (like the wildfly-extras/wildfly-jar-maven-plugin does) is tedious.
A proposal would be to configure https://github.com/wildfly-extras/ to have its own published web site (which would be https://wildfly-extras.github.io) so that any of its projects could use GitHub pages to publish content at their pace.

We could even go the extra mile and use a custom domain name for this web site to redirect to wildfly.org with something like: https://extras.wildfly.org/ (or https://incubator.wildfly.org/)

There would be an impact if we ever move a project from https://github.com/wildfly-extras/ to https://github.com/wildfly/ as we would break its URLs but this could be alleviated by adding some HTTP redirect rules in wildfly.org DNS (if that's possible)

[scottmarlow]

To publish wildfly/certifications we'd need to reorganize it to not use a branch per specification. @scottmarlow fyi

https://jakarta.ee/compatibility/certification/10/ is also a branched organization which I am mentioning in case that helps us consider other forms of branched certification information.

Somewhat thinking out loud here, but I we might be able to generate some kind of index page based on tags which would likely be better than branches.

My only concern about a flat page that has everything is what happens when it contains several more items over time (e.g. after 2 years and even more years), we could end up with a really large page that would need a reorganization because it would be too big to read.

[bstansberry]

I've thought about a couple of these and this is what I came up with:

For wildfly-proposals -- wildfly/wildfly-proposals#535
For wildfly-capabilities -- wildfly/wildfly-capabilities#51

Both of these projects are pretty similar; they provide many pages of fairly consistently structured adoc content that can be organized by categories of potential user interest. So we can curate the categories and generate an organized index.

[spyrkob]

@jmesnil was there any decision on publishing the docs of wildfly-extras projects? Is there anything I can help with to make that happen?