-
Notifications
You must be signed in to change notification settings - Fork 275
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
Conversation
* documents added Jackson JSR-310 dependency to REST API & web apps related to CAM-13937
@christinaausley, can you please do a technical writing review? 🙂 |
@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." |
Hi @christinaausley, thanks for the input. 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 🙂 |
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:
|
Thanks, Christina. |
I'm happy to open up a PR and fix it -- will add you as a reviewer once it's good to go. |
Sounds fantastic, thanks Christina 👍 🚀 |
related to CAM-13937