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

Improve the documentation for the Jetty Server Dump #12205

Open
wants to merge 5 commits into
base: jetty-12.0.x
Choose a base branch
from

Conversation

lachlan-roberts
Copy link
Contributor

Improve the Jetty Server Dump documentation and split it out from troubleshooting/index.adoc to its own page which can be linked more easily.

  • Split the docs for Jetty Server Dump out to its own page.
  • Add initial section about dumpAfterStart from command line and embedded usages.
  • operations-guide just links to the detailed Jetty Server Dump page in the programming guide so we don't duplicate these docs.

Signed-off-by: Lachlan Roberts <lachlan.p.roberts@gmail.com>
Signed-off-by: Lachlan Roberts <lachlan.p.roberts@gmail.com>
Signed-off-by: Lachlan Roberts <lachlan.p.roberts@gmail.com>
Signed-off-by: Lachlan Roberts <lachlan.p.roberts@gmail.com>
Signed-off-by: Lachlan Roberts <lachlan.p.roberts@gmail.com>
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.

@lachlan-roberts can you please restore the documentation as it was?

Let's discuss what you did not like, but we really want to keep the separation between operations and programming guide.

Comment on lines +43 to +44
Standalone Jetty uses two properties to control this behaviour which are referenced in `jetty.xml` to call these setters.
These properties are `jetty.server.dumpAfterStart` and `jetty.server.dumpBeforeStop`.
Copy link
Contributor

Choose a reason for hiding this comment

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

No, this is why previously the documentation was split.
This is the programming guide and referring to properties that are used only in the operations guide is not the correct place.

@gregw
Copy link
Contributor

gregw commented Sep 26, 2024

@lachlan-roberts status if this PR?

Copy link
Contributor

@gregw gregw left a comment

Choose a reason for hiding this comment

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

There is goodness in this PR... so lets not let it rot too long

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants