payara/payara-community-documentation

(Legacy) Asciidoc format documentation for the Payara Community Edition

Payara Community Edition Documentation Repository

Warning

This repository is no longer used to generate the Documentation for the Payara Platform Community edition and has been replaced by the unified documentation repository. This repository is kept for legacy purposes, as its used to generate the documentation for legacy releases equal to or older than 5.2022.1

Official technical documentation repository of the Payara Platform Community Edition which is maintained by members of the Payara organization. All documentation material is written in Asciidoctor format.

This documentation repository is structured in conformance to Antora version 2.3.0 format: https://docs.antora.org/antora/2.3/. This repository is used to generate all the HTML pages that are published at https://docs.payara.fish/community/ as configured in the Payara Documentation’s Antora Configuration Repository

Branches

All branches of this repository represent a different version of the Payara Platform’s Community Stream releases. In particular the following branches:

• 4.1.2.174

• 4.1.2.173

• 4.1.2.172

• 4.1.1.171

• 4.1.1.164

• 4.1.1.163

• 4.1.1.162

• 4.1.1.161.1

• 4.1.1.161

• 4.1.1.154

• 4.1.1.153

• 4.1.1.152.1

• 4.1.1.152

• 4.1.1.151

• 4.1.1.144

Correspond to older releases of the Payara Platform’s 4.1.x documentation and as such are not publicly available at the main site. Due to this, the file structure of these branches does not conform to the Antora layout.

payara-community-documentation's Issues

Incorrect example of deploying multiple applications from a Maven repository

https://docs.payara.fish/community/docs/5.2020.7/documentation/payara-micro/deploying/deploy-program-maven.html#deploying-multiple-applications-from-a-maven-repository

Last code snippet does not work as expected. Only application from the second addDeploymentFromGAV call will be deployed because they both have same context (same as atrifactId).

HSTS Enabled Documentation Incorrect

The HSTS Enabled documentation is incorrect (or I guess Payara's implementation of HSTS could be incorrect, I haven't verified).

The documentation states:

When enabled, the server will respond to insecure requests with the Strict-Transport-Security header. While these requests often return a 301 directing the client to the secure site, this header instructs the requester to make all connections to this site secure for the next year.

However, according to MDN:

The Strict-Transport-Security header is ignored by the browser when your site is accessed using HTTP; this is because an attacker may intercept HTTP connections and inject the header or remove it. When your site is accessed over HTTPS with no certificate errors, the browser knows your site is HTTPS capable and will honor the Strict-Transport-Security header.

Sending HSTS over insecure requests, per above, is pointless. HSTS should only go out over secure requests. So either the documentation is wrong, or the implementation is.

Examples shown in arquillian containers not working

I discovered problems in the payara arquillian container documentation after struggling to resolve this issue:
https://github.com/payara/ecosystem-arquillian-connectors/issues/51

I previously filed issues (here and here) for updating the documentation which have since been closed as the documentation has moved and has seen updates, but the issue remains that the documentation has non-working examples.

To summarize the details and conclusions from the previous issues, the examples in the arquillian container documentation show container properties defined as system properties in the surefire/failsafe plugin, but defining here does not work. The properties need to be defined in arquillian.xml to work properly. I believe the examples in the documentation should be changed to state this.

Docs containing eclipselink get modified to eclipsexref

The docs found under https://docs.payara.fish/docs/5.201/documentation/payara-server/jpa-cache-coordination.html contain errors. The package names and property names which should contain eclipselink do contain eclipsexref. Something has scrambled the string link to xref.

Documentation for arquillian-payara-server-remote connector appears to be out of date

The docs for this connector are still out of date in the new repo. This issue was previously filed in the now-archived repo: Payara-Server-Documentation issue #709

The documentation payara-remote arquillian container has documentation for <artifactId>arquillian-payara-server-4-remote</artifactId> instead of <artifactId>arquillian-payara-server-remote</artifactId>

I've been attempting to get arquillian to deploy and test against a remote payara server running in a separate docker container but bumped into problems, and I'm not sure if I'm using the proper configuration for the connector or not.

I've filed an issue against the connector here:
payara/ecosystem-arquillian-connectors#51