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

doc: Add deprecation notice to OBJ cluster-related modules & fields #526

Conversation

lgarber-akamai
Copy link
Contributor

@lgarber-akamai lgarber-akamai commented Jun 24, 2024

📝 Description

This pull request adds warnings to the documentation for fields and modules related to the OBJ cluster field, which is being deprecated as part of the Multicluster OBJ project.

✔️ How to Test

N/A

@lgarber-akamai lgarber-akamai added the documentation for updates to the documentation in the changelog. label Jun 24, 2024
@lgarber-akamai lgarber-akamai marked this pull request as ready for review June 24, 2024 18:35
@lgarber-akamai lgarber-akamai requested a review from a team as a code owner June 24, 2024 18:35
@lgarber-akamai lgarber-akamai requested review from jriddle-linode and yec-akamai and removed request for a team, jriddle-linode and yec-akamai June 24, 2024 18:35
@lgarber-akamai lgarber-akamai marked this pull request as draft June 24, 2024 18:36
@lgarber-akamai lgarber-akamai added the do-not-merge PRs that should not be merged until the commented issue is resolved label Jun 24, 2024
Comment on lines +179 to +183
# If cluster has been defined for any of the `access` objects,
# raise a deprecation warning
if access is not None and any(
v is not None for v in access if v.get("cluster", None)
):
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@zliang-akamai I think this deprecation will be dependent on TPT-2603, do you mind if I mark this PR as do not merge until that work is done?

@lgarber-akamai lgarber-akamai marked this pull request as ready for review June 24, 2024 19:08
@lgarber-akamai lgarber-akamai changed the base branch from dev to proj/multicluster-obj June 26, 2024 18:11
@lgarber-akamai lgarber-akamai merged commit 8666ee2 into linode:proj/multicluster-obj Jun 26, 2024
4 checks passed
@lgarber-akamai lgarber-akamai removed the do-not-merge PRs that should not be merged until the commented issue is resolved label Jun 26, 2024
@lgarber-akamai
Copy link
Contributor Author

Merged this pull request because it was re-pointed to the multicluster project branch 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation for updates to the documentation in the changelog.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants