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

Issue #5603 - Single page documentation #5636

Merged
merged 15 commits into from Nov 20, 2020

Conversation

WalkerWatch
Copy link
Contributor

@WalkerWatch WalkerWatch commented Nov 10, 2020

Issue #5603 Creates single page output for 9.4.x documentation and aligns with 10 and 11 documentation formatting.

@joakime joakime changed the title 9.4.x 5603 single page doc Issue #5603 - Single page documentation Nov 10, 2020
@jmcc0nn3ll
Copy link
Contributor

If we are going to wack out the docbook backend entirely we should clear out the xslt files, basically the src/main/docbkx-* directories. Might be good to go through and make sure none of that is referenced but I think that stuff was mostly just syntax highlighter and font type stuff.

Copy link
Contributor

@jmcc0nn3ll jmcc0nn3ll left a comment

Choose a reason for hiding this comment

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

See prior comment.

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.

I ran the documentation generation, and I get a ton of warnings and errors.

In particular, all source code blocks for XML are broken, so the generated documentation is unreadable.

Remove subs={sub-order} from everywhere, it's now broken, it's unnecessary in most cases, and should be explicitly added only in blocks that require it.

The "parts" use level 0 sections, should be using level 1 (see warning during generation).

There is also a number of invalid cross references that should be fixed.

jetty-documentation/pom.xml Outdated Show resolved Hide resolved
jetty-documentation/pom.xml Outdated Show resolved Hide resolved
@jmcc0nn3ll
Copy link
Contributor

As long as this visually looks fine I am good to go with it, it lets us get the updated website leveraging it so we can deploy that going into the 10 and 11 releases. Any content changes we need to make can be done separately.

@WalkerWatch
Copy link
Contributor Author

@sbordet Any other changes you'd like to see?

@WalkerWatch
Copy link
Contributor Author

@sbordet Done, not sure how I managed to miss those. CI Building now. Good to go when green?

@WalkerWatch WalkerWatch merged commit 41bf953 into jetty-9.4.x Nov 20, 2020
@sbordet sbordet deleted the 9.4.x-5603-SinglePageDoc branch November 20, 2020 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants