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

[Blog post] Introducing the 2 + 2 + 2 Java support plan #6809

Merged
merged 8 commits into from
Nov 6, 2023

Conversation

basil
Copy link
Contributor

@basil basil commented Nov 2, 2023

External user-facing communication about the 2 + 2 + 2 Java support plan, including the relevant upcoming dates as well as a practical discussion about the tradeoffs involved in making this decision.

Testing done

Viewed https://github.com/basil/jenkins.io/blob/java-blog-post/content/blog/2023/11/2023-11-06-introducing-2-2-2-java-support-plan.adoc and confirmed the content was readable and the dates were accurate.

@basil basil requested a review from a team as a code owner November 2, 2023 17:15
Copy link
Member

@lemeurherve lemeurherve left a comment

Choose a reason for hiding this comment

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

Small optional suggestion, great blog post!

@basil
Copy link
Contributor Author

basil commented Nov 2, 2023

The Gantt charts aren't being rendered, so once the content is finalized I will convert them to rendered images. I'll wait until after the content is finalized to ensure that I only have to do this a single time. If anyone has any better ideas about how to make the static site generator render the Gantt charts, let me know.

Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

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

Thanks.

I added an opengraph image in 79ced5f so that the list of pages would have a picture to describe the blog post. The picture was created from the Jenkins social media covers slide deck

@basil
Copy link
Contributor Author

basil commented Nov 3, 2023

I looked into trying to have Asciidoctor render the Gantt charts via asciidoctor-diagram, but this wasn't practical. asciidoctor-diagram requires mermaid-cli to be installed when it is running, but that is a JavaScript (not Ruby) package, and our build currently has separate stages and separate Docker environments for JavaScript and Ruby, so each environment is unavailable from the other. And this does keep the build nice and simple by allowing us to use unmodified upstream Docker images, in contrast to having to maintain an omnibus build environment ourselves with every possible tool installed.

So given the above, I ran asciidoctor-diagram locally with its SVG backend to generate rendered SVG versions of the Gantt charts, which I have included in this PR. While not as nice as being able to automatically render Mermaid markup, this is more practical because it avoids having to change our build significantly.

@basil
Copy link
Contributor Author

basil commented Nov 3, 2023

I have checked the preview site and confirmed the rendered SVG Gantt charts are displaying correctly.

Copy link
Contributor

@kmartens27 kmartens27 left a comment

Choose a reason for hiding this comment

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

This is great, thanks very much @basil.

I noted one small suggestion regarding a line, but outside of that everything looks good to me and the charts are rendering nicely.

Comment on lines +103 to +106
This plan balances the needs of large scale users for predictability and stability
with the needs of early adopters and developers
to improve and simplify Jenkins with the latest Java capabilities
and to reduce the maintenance overhead associated with a large build and test matrix.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This plan balances the needs of large scale users for predictability and stability
with the needs of early adopters and developers
to improve and simplify Jenkins with the latest Java capabilities
and to reduce the maintenance overhead associated with a large build and test matrix.
This plan balances the needs of large scale users for predictability and stability,
with the needs of early adopters and developers,
to improve and simplify Jenkins with the latest Java capabilities
and to reduce the maintenance overhead associated with a large build and test matrix.

Small suggestion to add some punctuation for sentence structure/avoiding a run on sentence.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

A run-on sentence occurs when two independent clauses run together without proper punctuation or appropriate conjunctions. A clause requires both a subject and a verb. This sentence has only one subject: "plan". The only other nouns in this sentence are functioning as direct objects or objects of prepositions. So there is no run-on sentence here.

This plan balances the needs of A for B with the needs of C to D and to E.

A = large scale users
B = predictability and stability
C = early adopters and developers
D = improve and simplify Jenkins with the latest Java capabilities
E = reduce the maintenance overhead associated with a large build and test matrix

Adopting your suggestion would result in the structure

This plan balances the needs of A for B, with the needs of C, to D and to E.

This places commas before two prepositions, which is grammatically incorrect for the reasons given in https://thecriticalreader.com/no-comma-before-or-after-a-preposition/

@kmartens27 kmartens27 merged commit a474c4e into jenkins-infra:master Nov 6, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants