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

New approach to referencing content in code blocks. #469

Merged
merged 2 commits into from
Dec 5, 2024

Conversation

jhkrug
Copy link
Contributor

@jhkrug jhkrug commented Nov 28, 2024

To be more in alignment with asciidoc, as used in product documentation for SUSE Admission Policy Manager.

To see the asciidoc version, for comparison, in product docs: https://github.com/jhkrug/kubewarden-product-docs/blob/40c59ee37760b9bb28f0c56e3c4fc545a40661b0/docs/next/modules/en/pages/reference/monitor-mode.adoc?plain=1#L30-L58

…n alignment with asciidoc.

Signed-off-by: John Krug <john.krug@suse.com>
@jhkrug jhkrug added the area/documentation Improvements or additions to documentation label Nov 28, 2024
@jhkrug jhkrug self-assigned this Nov 28, 2024
@jhkrug jhkrug requested a review from a team as a code owner November 28, 2024 13:36
@jhkrug jhkrug marked this pull request as draft November 28, 2024 13:37
@jhkrug
Copy link
Contributor Author

jhkrug commented Nov 28, 2024

Part of the work on #467. Any thoughts? Objections?

I think this is all OK. It's small changes. I don't think it affects usability or readability. Just different approaches. It will make the cross-fertilization of community and product docs a bit easier.

The reference mark in the code block (the (1)) is a bit indistinct in the Docusaurus/community version. Can be fixed with a styling update.

Copy link

netlify bot commented Nov 28, 2024

Deploy Preview for silly-bunny-8cedd0 ready!

Name Link
🔨 Latest commit aa16bf3
🔍 Latest deploy log https://app.netlify.com/sites/silly-bunny-8cedd0/deploys/67505b6e1eb398000864fda4
😎 Deploy Preview https://deploy-preview-469--silly-bunny-8cedd0.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@flavio flavio left a comment

Choose a reason for hiding this comment

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

Obviously the docusarurus highlight mode is nicer, but this approach works too. This resembles closely what we were doing before we learnt about that docusaurus feature :)

I'm fine moving forward with that

Copy link
Member

@jvanz jvanz left a comment

Choose a reason for hiding this comment

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

I'm fine too.

Copy link
Member

@viccuad viccuad left a comment

Choose a reason for hiding this comment

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

I'm also ok with it too.

@flavio
Copy link
Member

flavio commented Dec 2, 2024

Fixes #467

…code blocks

Signed-off-by: John Krug <john.krug@suse.com>
@jhkrug jhkrug changed the title Test new approach to referencing content in code blocks. New approach to referencing content in code blocks. Dec 4, 2024
@jhkrug jhkrug marked this pull request as ready for review December 4, 2024 13:45
@flavio flavio merged commit 6bb7e43 into kubewarden:main Dec 5, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants