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: add deprecation notice to cron on docs/job-specification/periodic #23424

Merged
merged 2 commits into from
Jun 24, 2024

Conversation

Antvirf
Copy link
Contributor

@Antvirf Antvirf commented Jun 23, 2024

Fixes #23391

There are quite a few different approaches to mark deprecation across the docs, I picked this as it was the most explicit parameter-level option in my opinion.

Screenshot below:

Screenshot from 2024-06-23 21-46-17

Other refs:

Copy link

hashicorp-cla-app bot commented Jun 23, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Member

@tgross tgross left a comment

Choose a reason for hiding this comment

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

Thanks for picking this up, @Antvirf. Changing the parameter to (string: <optional>) might be a little confusing though... I get where you're going with that, but it's required if crons is unset. Let's change it just (string) and change the note at the end of crons to:

Either cron or crons must be set, but not both.

And then add the same note to the end of cron too.

@Antvirf
Copy link
Contributor Author

Antvirf commented Jun 24, 2024

@tgross done 🫡

Screenshot from 2024-06-24 21-44-07

Copy link
Member

@tgross tgross left a comment

Choose a reason for hiding this comment

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

@tgross tgross added the backport/1.8.x backport to 1.8.x release line label Jun 24, 2024
@tgross tgross merged commit bbdc8b7 into hashicorp:main Jun 24, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/1.8.x backport to 1.8.x release line
Projects
Development

Successfully merging this pull request may close these issues.

Deprication for cron is not documented
2 participants