Hi Jacopo,
We could indeed link the pages at
https://github.com/apache/ofbiz-framework/tree/trunk/docs/asciidoc from the
OFBiz site, and possibly wiki.
There are several others too, like
https://github.com/apache/ofbiz-framework/blob/trunk/framework/security/src/docs/asciidoc/security.adoc
I'll update the bottom of this one in order to work in GH. It's OK in Eclipse
but also not on nightly, I don't know why yet (certainly paths issues)
Most of the ones in plugins needs also to be adapted, like
https://github.com/apache/ofbiz-plugins/blob/trunk/docs/asciidoc/plugins-user-manual.adoc
Maybe some even abandoned and just relying on the README.md at the roots of the
plugins.
Jacques
Le 09/04/2026 à 17:27, Jacopo Cappellato a écrit :
Hi Jacques,
My preference would be to remove these files (README, DOCKER, CONTRIBUTING)
from the nightlies and eliminate the Buildbot steps that generate and rsync
them at every build. This would also allow us to remove the folder
https://nightlies.apache.org/ofbiz/trunk/readme/ and its contents.
Providing both PDF and HTML versions of these files seems unnecessary and
adds little value. If we want to increase their visibility, we could
instead link directly to them (from our Wiki, website, etc.) on GitHub,
where they are already well presented.
Similarly, we could remove:
https://nightlies.apache.org/ofbiz/trunk/ofbiz/
and instead link directly to the documentation on GitHub, for example:
https://github.com/apache/ofbiz-framework/blob/trunk/docs/asciidoc/developer-manual.adoc
The GitHub browser view is simple, yet clear and complete, with a table of
contents and internal navigation links.
We are a small community, and OFBiz is a large codebase, so it’s important
to keep things as simple as possible. I would rather focus on improving the
content of these documents, since they could be better maintained.
As a side note, I would also like to remove the AsciiDoc-related tasks from
our build.gradle, as they rely on plugins that are not well supported and
generate warnings at every build. I am currently working on cleaning up all
warnings so that we can achieve clearer output, making it easier to review
logs and identify real issues.
Jacopo
On Thu, Apr 9, 2026 at 4:52 PM Jacques Le Roux via dev <[email protected]>
wrote:
Le 09/04/2026 à 11:42, Jacques Le Roux via dev a écrit :
Hi,
Currently we have none link from OFBiz site to AsciiDoc documentation
which is in nightlies.apache.org
For instance: https://nightlies.apache.org/ofbiz/trunk/ofbiz/
I did not quite check that, but the AsciiDoc documentation is much newer
that the one in Confluence and, at least for now, better maintained.
So, when I'll get enough time, I'll check and for now not replacing, but
adding links to the AsciiDoc documentation.
Jacques
I just realise that replacing README.adoc by README.md has an impact on
https://nightlies.apache.org/ofbiz/trunk/readme/html5/README.html (same
for
stable and next)
The file is still there, but it will no longer evolve (last change
* 2025-09-19 11:15:36 UTC for trunk,
* 2025-09-24 08:14:08 UTC for next,
* 2025-04-03 07:11:53 UTC for stable.
I see one solution for this problem with 2 possible alternatives.
The simple one, if it works, is to simply resurrect README.adoc or
resurrect and rename it.
Another is to resurrect and move it to another place (framework root ?)
It's maybe not the best solution, because it means to maintain 2 similar
files.
Though actually these files are pretty mature and does not need much
changes.
Else is it possible to handle README.md in BB (BuildBot) as it's done at
the moment for README.adoc (ie transforms it at least to HTML).
TIA
Jacques
