-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Jetty 12.0.x document modules #9151
Jetty 12.0.x document modules #9151
Conversation
Fine by me. Maybe
Good idea too. |
@gregpoulos I would standardize to |
...tation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-eex-webapp.adoc
Outdated
Show resolved
Hide resolved
...tation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-eex-webapp.adoc
Outdated
Show resolved
Hide resolved
...tation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-eex-webapp.adoc
Outdated
Show resolved
Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-jmx.adoc
Outdated
Show resolved
Hide resolved
All these suggestions look good to me. I'll implement them and post an update with the changes. |
...ntation/jetty-documentation/src/main/asciidoc/operations-guide/modules/modules-standard.adoc
Show resolved
Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/deploy.adoc
Show resolved
Hide resolved
...tation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-eeN-webapp.adoc
Outdated
Show resolved
Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/deploy.adoc
Show resolved
Hide resolved
…x-document-modules * upstream/jetty-12.0.x: Issue jetty#9167 - making assumption in flaky test jetty 12.0.x cleanup duplicate osgi pom metadata (jetty#9093) Jetty 12 - Add tests in util/resource for alternate FileSystem implementations (jetty#9149) Cleanup non-retainable `Retainable`s (jetty#9159) Fixes retainability of special Chunks (jetty#9073) TCK: Dispatch forward and includes attributes do not meet the spec (jetty#9074) re-enable h3 tests (jetty#8773) More fundamental test case Reorganization of jetty-client classes. (jetty#9127) Removing @disabled from SslUploadTest Removing @disabled from jetty-start jetty#9134 added test ee10: DefaultServlet: Replace checks for isStreaming() by !isWriting() jetty#9078 make HttpContent.getByteBuffer() implementations return new ByteBuffer instances and document that contract Fixes jetty#9141 - Thread-safe Content.Chunk#slice (jetty#9142) Remove `@Disabled` from `jetty-jmx` (jetty#9143) Bump maven.version from 3.8.6 to 3.8.7 Bump maven.version from 3.8.6 to 3.8.7
documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/deploy.adoc
Outdated
Show resolved
Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/deploy.adoc
Show resolved
Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/deploy.adoc
Outdated
Show resolved
Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/deploy.adoc
Show resolved
Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/jaspi/chapter.adoc
Show resolved
Hide resolved
...ntation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-resources.adoc
Outdated
Show resolved
Hide resolved
...ntation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-resources.adoc
Outdated
Show resolved
Hide resolved
...ntation/jetty-documentation/src/main/asciidoc/operations-guide/modules/modules-standard.adoc
Show resolved
Hide resolved
…x-document-modules * upstream/jetty-12.0.x: Documentation: for consistency, convert "JETTY_HOME" attribute to "jetty-home" (jetty#9152) suppress test stacks Jetty 12 temp directory cleanup (jetty#9153) Only use GraalIssue5720PathResourceFactory when truly needed Refactor Graal native-image resource: handling Move GraalVM Native-Image code to NativeImagePathResource/-Factory PathResource: Fix "isAlias" issue with resource: URIs PathResource: Work-around false positive CodeQL warning PathResourceFactory: Ignore certain RuntimeExceptions upon init PathResource: Selectively enable resource: for GraalVM Native Image URIUtil: Removed unused code URIUtil: Suppress CodeQL false positive error about path injection util: Add support for GraalVM Native-Image resource:-URIs and Paths
…-guide/begin/deploy.adoc Co-authored-by: Simone Bordet <[email protected]>
…-guide/modules/module-eeN-deploy.adoc Co-authored-by: Simone Bordet <[email protected]>
…egpoulos/jetty.project into jetty-12.0.x-document-modules * 'jetty-12.0.x-document-modules' of https://github.com/gregpoulos/jetty.project: Update documentation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-eeN-deploy.adoc
…-guide/modules/module-resources.adoc Co-authored-by: Simone Bordet <[email protected]>
…egpoulos/jetty.project into jetty-12.0.x-document-modules * 'jetty-12.0.x-document-modules' of https://github.com/gregpoulos/jetty.project: Update documentation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-resources.adoc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job!
@sbordet I wanted to run a couple of potential changes by you to get your thoughts.
What do you think of using the
module-eex-modulename.adoc
naming convention when we create documentation listings for modules that have multiple different versions for different EE platforms? The main advantage here is thateex
uses a common substitution convention that plays nicely with filenames. One disadvantage to this approach is that there there isn't an obvious "right" way to do alphabetical sorting. For example,module-eex-webapp.adoc
get automatically sorted under "E", but there's a good argument that it should appear under "W".For the
ee{8,9,10}-webapp
module documentation, I've used an ASCIIdocinclude::
statement to directly transclude the[description]
text directly fromee10-webapp.mod
. My goal in doing so is to reduce duplicated content, but if you'd prefer to avoid this approach, I can stop. (For example, maybe we'd prefer to avoid cluttering the.mod
files with extra markup, or perhaps the[description]
field serves a sufficiently distinct purpose from the documentation that they're worth maintaining separately.)