zaproxy-website
zaproxy-website copied to clipboard
zaproxy
Update docs to use blockquote alerts
Follows up on PR #2977.
Per my comment here, the plan is to modify just the docs, not existing articles. (What needs to be highlighted will probably be obvious in some of the articles, but I was thinking there's a risk of highlighting wrongly in articles where I don't have adequate context.)
Please let me know if you have any preferences about how to approach this.
Checkmarx One – Scan Summary & Details – 31e78060-84d8-42d1-a62f-fa0f2e0dc25e
Great job, no security vulnerabilities found in this Pull Request
That one looks good 😁 TBH I dont have a list of pages I think should be changed - I was planning on just changing things as I noticed them! I already added one here https://www.zaproxy.org/faq/somethings-not-working-what-should-i-do/#raise-an-issue
Note that everything in the Desktop User Guide is generated from Java Help, so changing that will not be so easy. We could put some special strings in the help which we would then convert, but it will require more work.
TBH I dont have a list of pages I think should be changed - I was planning on just changing things as I noticed them! I already added one here https://www.zaproxy.org/faq/somethings-not-working-what-should-i-do/#raise-an-issue
Got it. Also, looks good. 👍
Note that everything in the Desktop User Guide is generated from Java Help, so changing that will not be so easy. We could put some special strings in the help which we would then convert, but it will require more work.
Yeah, I remember @thc202 said 90% of the docs are generated from help content. I'll explore your suggestion to use special strings within the next couple of weeks.
FYI we use 3rd party lib to do the conversion, but then we have some of our own custom code in https://github.com/zaproxy/zap-admin/tree/master/buildSrc/src/main/java/org/zaproxy/gradle/website We would need to define some sort of convention for the blockquote alerts which doesnt break the Java Help but which is then recognised by our conversion code. That make sense?
That makes sense! I’ll keep you posted if I run into any issues once I get started.
@kingthorin @psiinon Please see my comment here about updating the alert template.
(Made it in a merged/closed PR, so was thinking you might miss it.)
@Wryhder I think your suggestions would be cleaner - so v happy for you to create a shortcode, or whatever you think would be best 😁