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.

Sign up for GitHub

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

Jump to bottom

Uniformise caution or warning directive usage #20371

Closed
MrYamous opened this issue Nov 7, 2024 · 3 comments · Fixed by #20449
Closed

Uniformise caution or warning directive usage #20371

MrYamous opened this issue Nov 7, 2024 · 3 comments · Fixed by #20449
Labels
good first issue Ideal for your first contribution! (some Symfony experience may be required) Hack Day hasPR A Pull Request has already been submitted for this issue.

Comments

@MrYamous
Copy link
Contributor

MrYamous commented Nov 7, 2024

Hi !
While working on a PR I did some research on layout details and realized that the caution or warning admonitions are rendered the same way in Symfony Doc. See Doctrine (this is warning) and Lock (this is caution) as exemples

I also found #19181 about about a previous work on caution and danger and IMO there is no particular need to introduce more granularity in the admonitions that are available by differentiating caution and warning
So I propose to remove one of the two syntaxes, maybe warning because it's the least used in the documentation

It's probably not a very important topic but looks good one to make documentation writing simpler and more understandable
@OskarStark
Copy link
Contributor

I am in favor of changing caution to warning, so we end up with: info, (tip), warning and danger. I would also want to have a doctor rule afterwards, keeping the docs clean from caution then. WDYT?

@TimoBakx
Copy link
Member

TimoBakx commented Dec 7, 2024

I'll work on this during the #SymfonyHackday.

TimoBakx added a commit to TimoBakx/symfony-docs that referenced this issue Dec 7, 2024
@TimoBakx
Replaced caution blocks with warning
3e91a17 
Fixes symfony#20371

Both blocks are currently rendered identically. Keeping only one of the two makes it easier to contribute.

Some blocks were elevated to danger.
@OskarStark OskarStark added good first issue Ideal for your first contribution! (some Symfony experience may be required) Hack Day labels Dec 7, 2024
TimoBakx added a commit to TimoBakx/symfony-docs that referenced this issue Dec 7, 2024
@TimoBakx
Replaced caution blocks with warning
8301aaa 
Fixes symfony#20371

Both blocks are currently rendered identically. Keeping only one of the two makes it easier to contribute.

Some blocks were elevated to danger.
@TimoBakx TimoBakx mentioned this issue Dec 7, 2024
Merged
TimoBakx added a commit to TimoBakx/symfony-docs that referenced this issue Dec 7, 2024
@TimoBakx
Replaced caution blocks with warning
3849004 
Fixes symfony#20371

Both blocks are currently rendered identically. Keeping only one of the two makes it easier to contribute.

Some blocks were elevated to danger.
wouterj added a commit that referenced this issue Dec 7, 2024
@wouterj
minor #20448 Replaced caution directive by warning (TimoBakx)
fdd5743 
This PR was merged into the 6.4 branch.

Discussion
----------

Replaced `caution` directive by `warning`

Fixes #20371

Both blocks are currently rendered identically. Keeping only one of the two makes it easier to contribute.

Some blocks were elevated to danger, as they describe a security risk.

Commits
-------

3849004 Replaced caution blocks with warning
@OskarStark
Copy link
Contributor

Closed in

@OskarStark OskarStark mentioned this issue Dec 7, 2024
Closed
@OskarStark OskarStark changed the title Uniformise caution or warning admonition usage Uniformise caution or warning directive usage Dec 7, 2024
TimoBakx added a commit to TimoBakx/symfony-docs that referenced this issue Dec 7, 2024
@TimoBakx
Replaced caution directive by warning
85ceb63 
Fixes symfony#20371
@TimoBakx TimoBakx mentioned this issue Dec 7, 2024
Merged
wouterj added a commit that referenced this issue Dec 7, 2024
@wouterj
minor #20449 Replaced caution directive by warning (TimoBakx)
79f9407 
This PR was merged into the 7.1 branch.

Discussion
----------

Replaced `caution` directive by `warning`

Fixes #20371

Commits
-------

85ceb63 Replaced `caution` directive by `warning`
TimoBakx added a commit to TimoBakx/symfony-docs that referenced this issue Dec 7, 2024
@TimoBakx
Replaced caution directive by warning
0a3fb8d 
Fixes symfony#20371
@TimoBakx TimoBakx mentioned this issue Dec 7, 2024
Merged
wouterj added a commit that referenced this issue Dec 7, 2024
@wouterj
minor #20450 Replaced caution directive by warning (TimoBakx)
719ea94 
This PR was merged into the 7.2 branch.

Discussion
----------

Replaced `caution` directive by `warning`

Fixes #20371

Commits
-------

0a3fb8d Replaced `caution` directive by `warning`
@xabbuh xabbuh added the hasPR A Pull Request has already been submitted for this issue. label Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Ideal for your first contribution! (some Symfony experience may be required) Hack Day hasPR A Pull Request has already been submitted for this issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Replaced caution directive by warning TimoBakx/symfony-docs
4 participants
@TimoBakx @OskarStark @xabbuh @MrYamous