3324 retro review

[christinaausley]

Description

Retro review of #3324.

When should this change go live?

• This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
• There is no urgency with this change.
• This change or page is part of a marketing blog, conference talk, or something else on a schedule.
• This functionality is already available but undocumented.
• This is a bug fix or security concern.

PR Checklist

• I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
• I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
• My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
• My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

[github-actions]

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.4/.

• docs/components/modeler/reference/modeling-guidance/rules/history-time-to-live.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

[christinaausley]

For accessibility purposes and to explain the screenshot, I added the following sentence. WDYT @toco-cam ?

[toco-cam]

@christinaausley It is unfortunately not that easy, as there are three options to set the HTTL which are valid (Listed above the pic):

• Define HTTL per model directly in Desktop Modeler.
• Set a default HTTL via an engine configuration.
• Switch off the HTTL check via an engine configuration if history cleanup is not used.

[toco-cam]

Who added the screenshot? The screenshot and your text only make sense for this bullet point "Define HTTL per model directly in Desktop Modeler."

[christinaausley]

Hi @toco-cam -- this is actually based on your PR, if you'd like to make additional changes.

[toco-cam]

Hi @christinaausley, ok, now it makes sense to me - all modeling guidance does have a screenshot displaying how the linting looks in the Modeler.

None of the other guidance has a caption - I would recommend not having one here, neither.

[akeller]

I'm good with these changes

[toco-cam]

I'm good with these changes

Hey @christinaausley, did you consider my comment here before merging?

[christinaausley]

@toco-cam This was merged two weeks ago, but I've kept this tab open to revisit, take a closer look, and add/remove captions as necessary based on your feedback.