Skip to content
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

Merged
merged 24 commits into from
Jan 19, 2023

Conversation

gregpoulos
Copy link
Contributor

@gregpoulos gregpoulos commented Jan 10, 2023

@sbordet I wanted to run a couple of potential changes by you to get your thoughts.

  1. 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 that eex 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".

  2. For the ee{8,9,10}-webapp module documentation, I've used an ASCIIdoc include:: statement to directly transclude the [description] text directly from ee10-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.)

@sbordet
Copy link
Contributor

sbordet commented Jan 10, 2023

What do you think of using the module-eex-modulename.adoc

Fine by me. Maybe eeN is better than eex?

I've used an ASCIIdoc include:: statement to directly transclude the [description] text directly from ee10-webapp.mod.

Good idea too.
I think perhaps you can shorten the tags, from documentation-description to just description, and documentation-ini-template to just ini-template.

@sbordet
Copy link
Contributor

sbordet commented Jan 10, 2023

@gregpoulos I would standardize to Servlet with capital S everywhere.

@gregpoulos
Copy link
Contributor Author

All these suggestions look good to me. I'll implement them and post an update with the changes.

…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
@sbordet sbordet requested review from sbordet and removed request for sbordet January 16, 2023 21:27
Greg Poulos and others added 5 commits January 17, 2023 11:48
…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]>
Greg Poulos and others added 5 commits January 17, 2023 13:14
…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
Copy link
Contributor

@sbordet sbordet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job!

@sbordet sbordet merged commit 06efbca into jetty:jetty-12.0.x Jan 19, 2023
gregpoulos pushed a commit to gregpoulos/jetty.project that referenced this pull request Feb 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants