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

Only show warning box if page is outdated #10411

Merged
merged 1 commit into from
Dec 21, 2024

Conversation

tetrapod00
Copy link
Contributor

@tetrapod00 tetrapod00 commented Dec 15, 2024

Additionally, changes the color of the warning box from green (tip colored) to orange (warning colored), which closes #7196.

Looks like this:

msedge_tDtOjgdb0F

We no longer display this admonition declaring the page up to date:
msedge_NXFLJtqigi

There are 46 of these outdated pages remaining.

(Originally, this PR only color-coded the boxes as the linked issue asks for.)

@tetrapod00 tetrapod00 added enhancement content:website Issues related to adding website features and fixing bugs, whether on the front or back-end labels Dec 15, 2024
@mhilbrunner
Copy link
Member

mhilbrunner commented Dec 15, 2024

Approving, although I'm wondering whether now that the dust has mostly settled, we should just have the "this page is outdated" one - a page not being outdated should be the expected state if there's nothing mentioned, after all?

This was different once when nearly everything was outdated due to Godot 4 being heavily WIP. It may even help a little bit with the notice-boxes-everywhere issue.

@tetrapod00
Copy link
Contributor Author

tetrapod00 commented Dec 15, 2024

100% in favor of no longer displaying the Up to date boxes, and only displaying the Work in progress ones. I figured that was already the plan, but the threshold for doing so was a smaller number of remaining outdated pages - 20? 10? 0? All the pages in #5121 being done?

The docs being generally up to date is expected behavior, and displaying a box to say that a page is up to date adds clutter to the page.

The continued existence of the Up to date box, and the fact that the text includes a minor version, implies a level of QA that frankly doesn't exist. We are not going over every page in each minor version to verify that it is "up to date for Godot 4.4". Instead, we at some point went over the page to verify that it is up to date for Godot 4.0.

The one point in favor of the Up to date boxes remaining is that it's another place that asks the reader to contribute if they see something wrong. But I don't think that's enough.

@tetrapod00
Copy link
Contributor Author

tetrapod00 commented Dec 15, 2024

Pushed an update to remove the Up to date box. (Once that's firmly approved I'll squash and update the PR)

Copy link
Member

@mhilbrunner mhilbrunner left a comment

Choose a reason for hiding this comment

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

LGTM. Considering the time of the year, I'm going to leave this open for a bit so others can still chime in.

Edit: for posterity, we already have thumb ups on this on RC from Mickeon, PatrickFlameLizard, Akien and Emi.

@tetrapod00 tetrapod00 force-pushed the color-code-up-to-date branch from 7445452 to f47af1f Compare December 16, 2024 22:47
@tetrapod00 tetrapod00 changed the title Use warning-colored admonition for outdated pages Only show warning box if page is outdated Dec 16, 2024
@mhilbrunner
Copy link
Member

mhilbrunner commented Dec 21, 2024

❄️ I think we have enough consensus to go ahead with this. Thanks everyone, and thanks tetrapod :)

@mhilbrunner mhilbrunner merged commit da1ef85 into godotengine:master Dec 21, 2024
1 check passed
@tetrapod00 tetrapod00 deleted the color-code-up-to-date branch December 21, 2024 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherrypick:4.0 cherrypick:4.1 cherrypick:4.2 cherrypick:4.3 content:website Issues related to adding website features and fixing bugs, whether on the front or back-end enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Info whether article is outdated should be color coded
4 participants