User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.6.1
Honestly, when we release version, it should
be released WITH the documentation. Not
before, not after.
Current state is that after some 90
days after GF7.0.0 we still have documentation in snapshot. And I
don't see that anyone intensively updating the adoc files.
Also with every minor release it should
contain notes about changes, so every time we release some change
in behavior it should be documented. For major releases in own
directory on the website, for minor and patch releases just in
notes in the version's pdf.
The website - it can change it's
structure and styles, so maybe we should release also standalone
jar with PDF and another with HTML (now contains both types).
Maybe we should release yet another with original/transformed adoc
files, which could be processed with customized styles in the
future. Then there are yet man pages.
The website is a standalone
distribution with a standalone lifecycle - and containing several
versions, and can also contain much more (examples, news, links,
updates, removals of dead links, ...).
David.
On 22. 01. 23 14:13, Ondro Mihályi
wrote:
I'm not sure if it's wise to do 3) - release docs
together with other GF artifacts, because we often forget to
update the docs. If we do that, we should either remember to
update the docs BEFORE a release and not after, or still
keep a separate job to update the docs if we need to update
it after a release.
For 1) and 2) - I don't mind separating the website to
its own github project but I don't think that the current
status causes confusion. I would rather keep everything in
the same repository, to make it easier to maintain and keep
the docs up to date. Especially if we decide to release the
docs together with other GF artifacts.
In my view, the biggest problem is that we don't have
a unified procedure to follow when releasing a new
GlassFish version, with all the steps that should be done,
including deploying the docs artifact. Even if we
automatically deploy docs, it doesn't mean that the docs
will be up to date with the new changes. And it won't
automatically publish them on the web site, which needs to
be updated to pull the new version of the docs artifact.
1) How do you login to Nexus? Do you use some login
name or your email?
2) Should I create a gitlab issue to resolve it, or
contact someone by email?
Then it seems to me that the previous job was just a
hack to generate 5.1 docs with the same content as
previous version, just with updated version ID.
Now we have updated documentation with further
evolution - still behind master, but at least it started
moving, you can compare the difference:
So, we need to fix 2 things in order to fix the
documentation and update it on the website:
Deploy also the docs distribution artifact
v7.0.0 to Jakarta Staging repo
Update the GF version references in the 6.2.5
docs to refer to 6.2.5 (or 6.2) instead of 5.1
Only step 1 is needed to publish the docs for GF
7 on the website with my PR https://github.com/eclipse-ee4j/glassfish/pull/24238.
It would publish also the GF 6 docs, which
incorrectly reference 5.1 but we can fix that in a
separate PR.
Maven artifacts (jar files with PDF+HTML
inside) should be here (I have found the URL in
job logs), but I can't log in for some reason
(used same credentials I have for eclipse
accounts):
I recommend to look inside, because I have doubts
if 6.2.5 doesn't just reuse 7.0.0 docs with
replaced version number ... ? I may be wrong ...
David.
On 21. 01. 23 20:26, Ondro Mihályi wrote:
If I understand it correctly, PUBLISH isn't
needed anymore. The /glassfish-docs-publish
job builds and deploys the docs distribution
artifacts into Maven Central, into the staging
area.
It's now enough to approve the org.glassfish.docs:distribution
artifacts staged in Maven Central.
Dear committers, can you please review and
approve deployment of the org.glassfish.docs:distribution
version
6.2.5 and
7.0.0 in Maven Central
Nexus repository?
Then we can merge my PR https://github.com/eclipse-ee4j/glassfish/pull/24238,
which would trigger an update of the website.
This would build the website, including
downloading docs distributions for all GF
versions (5.1, 6.2.5, and 7.0.0).
With the next release, the docs.7x.version
in the pom.xml of the docs/publish module will
be updated for the new 7.x version, together
with updating the Download page and the News
section. Once this is merged to master, Github
will update the website again, including the
docs.
I made a minimal
revision, but perhaps another pom fix
is needed to prevent unintentional
pushing to gh-pages. (we can recover
it by rerunning, so it might not be a
problem, though.)
I’m
not a GlassFish committer (yet) but
I agree with David - it’s enough to
just make the change to the job and
ask on the mailing list to review it
before running it. Although only
committers will be able to review
it, it should be enough for now.
I suppose I
could work on it, but
would like to make the
changes reviewable. Is
there a suitable
repository somewhere?
Kind Regards,
Hiroki
From:
glassfish-dev <glassfish-dev-bounces@xxxxxxxxxxx>On Behalf Of Ondro
Mihalyi Sent: Tuesday,
January 17, 2023 8:13 AM To: glassfish
developer discussions
<glassfish-dev@xxxxxxxxxxx> Subject:
[glassfish-dev]
GlassFish 6 & 7 docs
artifacts missing in
Maven Central
Hi,
While
updating glassfish.org
with info about
GlassFish 7 release, I
discovered that the
Documentation page is
also not up to date
with the GlassFish 7
version, and not even
with the GlassFish 6
version. For example,
the docs for the
"current" release show
docs for GlassFish
5.1: https://glassfish.org/docs/
I've
created a PR to fix
this, but this
requires that the
org.glassfish.docs:distribution
artifact version 6.2.5
and 7.0.0 are in a
Maven repo, either in
Maven Central or in a
Jakarta repo, which is
accessible from
GlassFish Jenkins
instance.
Can
somebody from the
committers deploy
the missing versions
6.2.5 and 7.0.0 of
the
org.glassfish.docs:distribution
artifact into Maven
Central? The
source code of this
artifact is in
https://github.com/eclipse-ee4j/glassfish/tree/master/docs/distribution.
I also suggest
adjusting the current
release CI jobs to
deploy this artifact
together with other
release artifacts in
the future.