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

docs(update): handle Java 8 Time objects #1111

Merged
merged 1 commit into from
Nov 22, 2021
Merged

Conversation

tmetzke
Copy link
Member

@tmetzke tmetzke commented Nov 22, 2021

  • documents added Jackson JSR-310 dependency to REST API & web apps

related to CAM-13937

* documents added Jackson JSR-310 dependency to REST API & web apps

related to CAM-13937
@tmetzke tmetzke self-assigned this Nov 22, 2021
@tmetzke tmetzke merged commit 87c6bda into master Nov 22, 2021
@tmetzke tmetzke deleted the CAM-13937-rest-java-8-time branch November 22, 2021 12:55
@tmetzke
Copy link
Member Author

tmetzke commented Nov 26, 2021

@christinaausley, can you please do a technical writing review? 🙂

@christinaausley
Copy link
Contributor

christinaausley commented Nov 29, 2021

@tmetzke From a technical writing perspective, this looks good to me. Well-worded and well-written, but may make sure sentences are either within one paragraph or have a space between paragraphs/sentences according to paragraph form. For example:

"Starting with version 2.12.0, Jackson throws an exception in such cases. Therefore, the REST API and web applications now register an appropriate module.

This allows you to keep using Java 8 date and time data types when updating to a newer Jackson version. However, this can also lead to changed serialized data for such values."

@tmetzke
Copy link
Member Author

tmetzke commented Nov 30, 2021

Hi @christinaausley, thanks for the input.
If you have a look at https://stage.docs.camunda.org/manual/7.16/update/patch-level/#7-16-1-to-7-16-2-7-15-7-to-7-15-8, does it look as expected?

I guess this might be a misunderstanding in how Hugo picks up the markdown. Hugo strips away single newlines and considers all text as one paragraph. Only double newlines will create a new paragraph.

Let me know if I got anything wrong here 🙂

@christinaausley
Copy link
Contributor

Excellent! Dismiss my spacing comments then. Thanks for clarifying as I'm still understanding the processing of Hugo.

One last note is that we do need to capitalize each word after its numerical introduction, followed by a period rather than a comma. For example:

  1. Update the Process Engine library in your dependency management (Apache Maven, Gradle …).
  2. Re-package the application.
  3. Deploy the new version of the application.

@tmetzke
Copy link
Member Author

tmetzke commented Dec 1, 2021

Thanks, Christina.
As I have not touched that part of the page with the bullet points, how should we handle this?
Should we create a new ticket and PR?

@christinaausley
Copy link
Contributor

I'm happy to open up a PR and fix it -- will add you as a reviewer once it's good to go.

@tmetzke
Copy link
Member Author

tmetzke commented Dec 1, 2021

Sounds fantastic, thanks Christina 👍 🚀

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.

3 participants