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

[AsciiDoc conversion] Admonitions (notes) in list items not rendered properly #224

Open
iansk opened this issue Oct 18, 2023 · 2 comments
Open

Comments

@iansk
Copy link
Collaborator

iansk commented Oct 18, 2023

Admonitions (notes) in procedure steps (list items) are being rendered as paras, not admonitions

See this page on Franklin (search for "The process of submitting a PR to fix the issue directly"):

https://main--prisma-cloud-docs-website--hlxsites.hlx.page/en/enterprise-edition/content-collections/alerts/view-respond-to-prisma-cloud-alerts?branch=fix-in-code

franklin-uat-admonitions-in-steps

Adoc source:

https://github.com/hlxsites/prisma-cloud-docs/blob/a3c2e711b2a004bda2e12d5f9b535657c8ab42dc/docs/en/enterprise-edition/content-collections/alerts/view-respond-to-prisma-cloud-alerts.adoc?plain=1#L164-L173

.. Fix the problem.

* Use *Send To Jira* to file a ticket for the application team, if you do not have the authority to fix the issue.
* Use *Fix in Cloud* to prevent an incident from occurring in runtime. Prisma Cloud can automatically execute the CLI command provided in the policy recommendations to resolve the misconfiguration.
* Use *Fix in Code* if you have access to the IaC resource and can submit a PR to the Version Control System.
+
When the issue is addressed, the alert is moved to a Pending Resolution or Resolved state, and the risk is addressed.
+
NOTE: The process of submitting a PR to fix the issue directly in code is an offline process. When the process completes and the PR is submitted, the button will update to *View Details* and you can access the link to view the PR in your VCS.

Notes should be rendered like this:

franklin-uat-admonitions
@3vil3mpir3
Copy link

3vil3mpir3 commented Oct 19, 2023

@maxakuru This looks similar to the issues with tables being in nested list items. Can you have a look? Here's a link to one that works, but is not in a nested li structure
https://docs.prismacloud.io/en/compute-edition/31/admin-guide/waas/waas-dos-protection

@maxakuru
Copy link
Contributor

@iansk this is caused by inability to nest blocks in lists. admonition is a block and can't exist in lists

we can add custom syntax that gets built into a block on the client (like we discussed last week) if this is needed..
for example by replacing instances of a specific string, like

admonition:NOTE: The process of submitting a PR... :

otherwise it will just need to be a restriction on what can be authored.. wdyt?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants