Add apidocs classifier for publishing to docs.spring.io #3328
+39
−7
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
in docs.spring.io, there is an
autorepo
script which automates the deployment todocs.spring.io
of any docs zip deployed to artifactory.the convention is the following:
any docs zip published to artifactory should contain
zip.type=docs
, andzip.deployed=false
special artifactory properties. see spring framework example, or spring pulsar example.the structure of the docs zip should be like this:
Now, our current reactor-netty-docs zip contains only the html files and the structure is different (
docs/*
).We can't change the layout of the reactor-netty-docs zip, else it could break any other components, like the projectreactor.io site, which expects reference documentation to be located in docs/* sub directory of the docs zip.
So, this PR just adds a new reactor-netty
apidocs
classifier which contains:the new apidocs artifact will be published with the special properties
zip.type=docs
andzip.deployed=false
, so the content of the apidocs artifact will also be copied to:https://docs.spring.io/projectreactor/netty/docs/VERSION/api/
(javadoc)https://docs.spring.io/projectreactor/netty/docs/VERSION/reference/html/
(reference doc)https://docs.spring.io/projectreactor/netty/docs/VERSION/reference/pdf/
(pdf reference doc)not that the autorepo script also uses autoln, which will maintain symbolic links like:
https://docs.spring.io/projectreactor/netty/docs/current ->
(the latest stable docs)https://docs.spring.io/projectreactor/netty/docs/current-SNAPSHOT ->
(the most recent snapshot docs)https://docs.spring.io/projectreactor/netty/docs/<major>.<minor>.x ->
(the most recently released version starting with<major>.<minor>
)https://docs.spring.io/projectreactor/netty/docs/<major>.<minor>.x-SNAPSHOT ->
(the most recent snapshot docs starting with<major>.<minor>
)