From a4aa97a3df0c7988d214cdf8ec2b650f94cafba1 Mon Sep 17 00:00:00 2001 From: Najam Ul Saqib Date: Thu, 28 Sep 2023 12:43:40 +0500 Subject: [PATCH 1/3] setup directory for hud docs Signed-off-by: Najam Ul Saqib --- site/content/docs/_index.md | 4 ++++ site/content/docs/hud/_index.md | 9 +++++++++ 2 files changed, 13 insertions(+) create mode 100644 site/content/docs/hud/_index.md diff --git a/site/content/docs/_index.md b/site/content/docs/_index.md index eae992274..6e8209a6e 100644 --- a/site/content/docs/_index.md +++ b/site/content/docs/_index.md @@ -62,6 +62,10 @@ groups: link: /docs/constants/ desc: defined in the ZAP codebase that are exposed via the API and/or scripts + - name: 'Heads Up Display (HUD)' + link: /docs/hud/ + desc: detailed information on the HUD + - name: 'Internal Events' link: /docs/internal-events/ desc: detailed information on the internal events ZAP publishes diff --git a/site/content/docs/hud/_index.md b/site/content/docs/hud/_index.md new file mode 100644 index 000000000..2584bcbe6 --- /dev/null +++ b/site/content/docs/hud/_index.md @@ -0,0 +1,9 @@ +--- +title: "ZAP HUD" +type: page +layout: links +--- + +# HUD Details +Hello HUD! + From 20ae34f8a59de56b6a793bc57d639ee56aebd4b4 Mon Sep 17 00:00:00 2001 From: Najam Ul Saqib Date: Thu, 28 Sep 2023 16:21:16 +0500 Subject: [PATCH 2/3] port getting started page from hud wiki Signed-off-by: Najam Ul Saqib --- site/content/docs/hud/_index.md | 8 ++++++-- site/content/docs/hud/getting-started.md | 17 +++++++++++++++++ 2 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 site/content/docs/hud/getting-started.md diff --git a/site/content/docs/hud/_index.md b/site/content/docs/hud/_index.md index 2584bcbe6..4a3f55d34 100644 --- a/site/content/docs/hud/_index.md +++ b/site/content/docs/hud/_index.md @@ -2,8 +2,12 @@ title: "ZAP HUD" type: page layout: links +links: + - name: 'Getting Started' + link: getting-started/ + desc: a good place to start if you are new to ZAP's HUD --- -# HUD Details -Hello HUD! +Welcome to the ZAP HUD (Heads Up Display) documentation. With the HUD, you can use your favorite ZAP features, right in the browser. Following are the links that explain various areas of HUD + diff --git a/site/content/docs/hud/getting-started.md b/site/content/docs/hud/getting-started.md new file mode 100644 index 000000000..0633839f0 --- /dev/null +++ b/site/content/docs/hud/getting-started.md @@ -0,0 +1,17 @@ +--- +title: "Getting Started" +--- + + +The HUD is an extension to ZAP, so to run the HUD you need to first start ZAP. There are two ways to start ZAP: +1. Run from HUD directory with gradle + +``` +git clone https://github.com/zaproxy/zap-hud.git +cd zap-hud +./gradlew runZap +``` + +2. Download ZAP from https://www.zaproxy.org/download/ + +After starting ZAP press "Manually Explore", make sure the "Enable HUD" checkbox is checked, and press "Start Browsing" to launch a browser with the HUD enabled. From 63c7d96a567844ca2b631da2abdd69b9abc90fe5 Mon Sep 17 00:00:00 2001 From: Najam Ul Saqib Date: Thu, 2 Jan 2025 17:54:53 +0500 Subject: [PATCH 3/3] add usage details Signed-off-by: Najam Ul Saqib --- site/content/docs/hud/_index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/site/content/docs/hud/_index.md b/site/content/docs/hud/_index.md index 4a3f55d34..a1db2de24 100644 --- a/site/content/docs/hud/_index.md +++ b/site/content/docs/hud/_index.md @@ -6,6 +6,9 @@ links: - name: 'Getting Started' link: getting-started/ desc: a good place to start if you are new to ZAP's HUD + - name: 'Using the HUD' + link: using-the-hud/ + desc: a guide to using the HUD --- Welcome to the ZAP HUD (Heads Up Display) documentation. With the HUD, you can use your favorite ZAP features, right in the browser. Following are the links that explain various areas of HUD