Skip to content

feat: support warnings in the generated advanced config pages #866

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

Merged
merged 1 commit into from
May 26, 2025

Conversation

jadkik
Copy link
Contributor

@jadkik jadkik commented May 22, 2025

Describe your changes

With a new flag added to the API we can generate a better-looking warning rather than relying on the plain text in the description.

Results

With the custom CSS `.property-warning`:

image

The changes for this alternative are no longer in the PR

With the standard CSS `.brand .brand--warning`:

image

It would look different from the badges in our own code, e.g. here:

image

I couldn't figure out how to reuse the code from our own component in the generated code:

https://github.com/aiven/aiven-docs/blob/d10e2dc0bfcc88f82a2d24a5aee55be1bfbbe1da/src/components/Badges/LimitedBadge/index.tsx

Checklist

  • The first paragraph of the page is on one line.
  • The other lines have a line break at 90 characters.
  • I checked the output.
  • I applied the style guide.
  • My links start with /docs/.

Copy link

cloudflare-workers-and-pages bot commented May 22, 2025

Deploying aiven-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: f3998d9
Status: ✅  Deploy successful!
Preview URL: https://7ca550af.aiven-docs.pages.dev
Branch Preview URL: https://add-support-for-restart-warn.aiven-docs.pages.dev

View logs

@github-actions github-actions bot added the tech Relates to technical updates of the docs platform. label May 22, 2025
@wojcik-dorota wojcik-dorota self-assigned this May 23, 2025
@jadkik jadkik force-pushed the add-support-for-restart-warnings branch 3 times, most recently from 1e8ccf1 to e5f8961 Compare May 26, 2025 12:29
@jadkik jadkik marked this pull request as ready for review May 26, 2025 12:30
@jadkik jadkik requested a review from a team as a code owner May 26, 2025 12:30
@jadkik jadkik force-pushed the add-support-for-restart-warnings branch from e5f8961 to 08c2bd4 Compare May 26, 2025 13:01
@jadkik jadkik force-pushed the add-support-for-restart-warnings branch from 08c2bd4 to f3998d9 Compare May 26, 2025 13:06
@wojcik-dorota
Copy link
Contributor

wojcik-dorota commented May 26, 2025

@jadkik , thank you! Let's have another pair of eyes on this one, from the team :-)

@jadkik jadkik requested review from a team and bugant May 26, 2025 13:31
Copy link

@bugant bugant left a comment

Choose a reason for hiding this comment

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

LGTM

@wojcik-dorota wojcik-dorota merged commit 70abd7e into main May 26, 2025
7 checks passed
@wojcik-dorota wojcik-dorota deleted the add-support-for-restart-warnings branch May 26, 2025 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tech Relates to technical updates of the docs platform.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants