-
Notifications
You must be signed in to change notification settings - Fork 40
How to add API SPI javadocs for every release
Steps to check in API/SPI javadoc changes for every release:
-
Get the generated files from Harry Hoots or we can get it from here the base link for the official release builds: Liberty GM build and under that you find the build that is tagged as 'gm' for the release, click on
Download
and search for these 2 files:open-liberty-adoc.zip
com.ibm.openliberty.javadoc.doc.jar
unzip these into a temp dir
-
clone [email protected]:OpenLiberty/docs-javadoc.git
-
create a new branch off
prod
-
create a new folder name based on version for that release under modules/reference for example next release will be
modules/reference/23.0.0.7
-
from the unzip
com.ibm.openliberty.javadoc.doc.jar
, copy all the -javadoc folders intomodules/reference/23.0.0.7
-
git add -A && git commit -m "api/spi javadoc for 23.0.0.7"
-
git push
-
create PR, review & merge into
staging
Skip step 3 (Chuck handles step 3 every release - has confirmed with Chuck)
-
clone [email protected]:OpenLiberty/docs-generated.git
(this is a Chuck thing to do?)
-
create a new branch off
v23.0.0.7-staging
-
from the unzip
com.ibm.openliberty.javadoc.doc.jar
- copy the
feature-nav-api-openliberty.adoc
&feature-nav-api-openliberty.adoc
files intomodules/reference/partials
- copy all
.adoc
files (api
andspi
underiframe
folder intomodules/reference/pages/javadoc
- copy the
-
from the unzip
open-liberty-adoc.zip
- copy
nav/feature-nav.adoc
&nav/config-nav.adoc
files intomodules/reference/partials
- copy all .adoc files under
feature
folder intomodules/reference/pages/feature
- copy all .adoc files under
config
folder intomodules/reference/pages/config
- copy
-
git add -A && git commit -m "api/spi javadoc for 23.0.0.7"
-
git push
-
create PR, review & merge
- update
nav.doc
forv23.0.0.7-staging
(David Mueller will take care of this?), follow this https://github.com/OpenLiberty/docs#editing-the-docs-navigation to add
include::reference:partial$feature-nav-api-openliberty.adoc[]
include::reference:partial$feature-nav-spi-openliberty.adoc[]