Skip to content

Docs: Add prominent deprecations notice via css - #43909

Merged
kaxil merged 1 commit into
apache:mainfrom
geraj1010:airflow_41532
Nov 29, 2024
Merged

Docs: Add prominent deprecations notice via css #43909
kaxil merged 1 commit into
apache:mainfrom
geraj1010:airflow_41532

Conversation

@geraj1010

@geraj1010 geraj1010 commented Nov 12, 2024

Copy link
Copy Markdown
Contributor

Updated deprecated Bigquery docstrings with the .. warning:: admonition and added custom CSS styling, which will apply to all .. warning:: admonitions found in docstrtings.

closes #41532

@ashb

ashb commented Nov 12, 2024

Copy link
Copy Markdown
Member

Could you include before and after pics please?

And if we use .. warning:: anywhere else before and after of one those too please

@kaxil

kaxil commented Nov 12, 2024

Copy link
Copy Markdown
Member

Screenshots are here: #41532 (comment)

@geraj1010

geraj1010 commented Nov 13, 2024

Copy link
Copy Markdown
Contributor Author

For BigQueryExecuteQueryOperator:

Before:
image

After:
image

There are other operators that use .. warning:: in their docstring, here is CloudDataTransferServiceCreateJobOperator

Before:
image

After:
image

So the styling appears to apply to all docstrings, which use the .. warning:: admonition (since the CSS is in docs/sphinx_design/static/custom.css) . If that is an issue, I could create a .css specifically for Google Providers if that helps. Then that would restrict the styling to Google Providers.

@geraj1010

Copy link
Copy Markdown
Contributor Author

@ashb Did I provide enough screenshots? Are there any other concerns?

@kaxil kaxil changed the title Airflow 41532: Updated Bigquery Deprecated Operator Docstrings Updated Bigquery Deprecated Operator Docstrings Nov 15, 2024
@kaxil

kaxil commented Nov 15, 2024

Copy link
Copy Markdown
Member

We should do the same for all deprecated operators too

@geraj1010

Copy link
Copy Markdown
Contributor Author

We should do the same for all deprecated operators too

That would be great. I could go through and apply this update to all deprecated operators. Unfortunately, it's a manual effort. I did mention something about extending the Sphinx AutoAPI extension (#41532 (comment)), but that would take more work for sure.

@potiuk

potiuk commented Nov 28, 2024

Copy link
Copy Markdown
Member

You need to rebase/resolve conflicts @geraj1010

@omkar-foss

omkar-foss commented Nov 28, 2024

Copy link
Copy Markdown
Collaborator

I could go through and apply this update to all deprecated operators. Unfortunately, it's a manual effort. I did mention something about extending the Sphinx AutoAPI extension (#41532 (comment)), but that would take more work for sure.

No problem, I can help with applying this update to all deprecated operators.

@kaxil @potiuk Shall I raise a separate PR with commits from this PR or something else, please let me know. Thank you :)

@potiuk

potiuk commented Nov 28, 2024

Copy link
Copy Markdown
Member

@kaxil @potiuk Shall I raise a separate PR with commits from this PR or something else, please let me know. Thank you :)

If @geraj1010 is ok with it, absolutely - feel free.

@kaxil

kaxil commented Nov 28, 2024

Copy link
Copy Markdown
Member

I could go through and apply this update to all deprecated operators. Unfortunately, it's a manual effort. I did mention something about extending the Sphinx AutoAPI extension (#41532 (comment)), but that would take more work for sure.

No problem, I can help with applying this update to all deprecated operators.

@kaxil @potiuk Shall I raise a separate PR with commits from this PR or something else, please let me know. Thank you :)

I think we can merge this one to credit @geraj1010

@kaxil kaxil changed the title Updated Bigquery Deprecated Operator Docstrings Docs: Add prominent deprecations notice via css Nov 29, 2024
@kaxil
kaxil merged commit 840018a into apache:main Nov 29, 2024
@kaxil

kaxil commented Nov 29, 2024

Copy link
Copy Markdown
Member

I resolved the conflict, and merged

@kaxil

kaxil commented Nov 29, 2024

Copy link
Copy Markdown
Member

Verified it locally:

image

@kaxil kaxil added this to the Airflow 2.10.4 milestone Nov 29, 2024
@kaxil

kaxil commented Nov 29, 2024

Copy link
Copy Markdown
Member

@eladkal Worth including this change in the next batch of providers

@omkar-foss

Copy link
Copy Markdown
Collaborator

Thanks a lot for looking into this @kaxil, and kudos @geraj1010 for this PR!

I've raised #44479 to use the warning block wherever applicable, so that we can show these prominent deprecation warnings consistently across Airflow docs. Cheers.

@geraj1010

Copy link
Copy Markdown
Contributor Author

Thanks a lot for looking into this @kaxil, and kudos @geraj1010 for this PR!

I've raised #44479 to use the warning block wherever applicable, so that we can show these prominent deprecation warnings consistently across Airflow docs. Cheers.

My pleasure!

@geraj1010

Copy link
Copy Markdown
Contributor Author

Greetings, I was away for the holidays. Thank you all for review!

@kaxil Thank you for resolving the conflict. Can you please tell me what it was?

@geraj1010
geraj1010 deleted the airflow_41532 branch December 1, 2024 03:15
@kaxil

kaxil commented Dec 1, 2024

Copy link
Copy Markdown
Member

Greetings, I was away for the holidays. Thank you all for review!

@kaxil Thank you for resolving the conflict. Can you please tell me what it was?

Hi @geraj1010 , I hope you had a good holiday. Your base branch was 1000 commits behind the Airflow main -- Example: https://github.com/apache/airflow/commits/39ebd75c5cb066218a2b6b3940eddc217dd816d9/docs/sphinx_design/static/custom.css -- your branch's base commit was from December 2023 -- so rebased on the main branch.

image

@geraj1010

geraj1010 commented Dec 1, 2024

Copy link
Copy Markdown
Contributor Author

Greetings, I was away for the holidays. Thank you all for review!
@kaxil Thank you for resolving the conflict. Can you please tell me what it was?

Hi @geraj1010 , I hope you had a good holiday. Your base branch was 1000 commits behind the Airflow main -- Example: https://github.com/apache/airflow/commits/39ebd75c5cb066218a2b6b3940eddc217dd816d9/docs/sphinx_design/static/custom.css -- your branch's base commit was from December 2023 -- so rebased on the main branch.

Ahh I see! I wonder how that happened? I've only started contributing in August 2024. Maybe I forked the repo incorrectly?

got686-yandex pushed a commit to got686-yandex/airflow that referenced this pull request Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deprecation of operators should be prominently highlighted instead of the one line remark in the documentation

5 participants