feat(docs): Fix images and ToC 03/38503/1
authorpmikus <peter.mikus@protonmail.ch>
Thu, 16 Mar 2023 12:35:47 +0000 (12:35 +0000)
committerpmikus <peter.mikus@protonmail.ch>
Thu, 16 Mar 2023 12:35:47 +0000 (12:35 +0000)
Signed-off-by: pmikus <peter.mikus@protonmail.ch>
Change-Id: I4f2327c9dbbc3b2d652c9882c29573cfe4469c63

35 files changed:
csit.infra.hugo/docker-compose.yaml
docs/config.toml
docs/content/introduction/design.md
docs/content/methodology/access_control_lists.md
docs/content/methodology/data_plane_throughput/data_plane_throughput.md
docs/content/methodology/data_plane_throughput/mlrsearch.md
docs/content/methodology/data_plane_throughput/mrr_throughput.md
docs/content/methodology/data_plane_throughput/plrsearch.md
docs/content/methodology/dut_state_considerations.md
docs/content/methodology/generic_segmentation_offload.md
docs/content/methodology/geneve.md
docs/content/methodology/hoststack_testing/quicudpip_with_vppecho.md
docs/content/methodology/hoststack_testing/tcpip_with_iperf3.md
docs/content/methodology/hoststack_testing/udpip_with_iperf3.md
docs/content/methodology/hoststack_testing/vsap_ab_with_nginx.md
docs/content/methodology/internet_protocol_security_ipsec.md
docs/content/methodology/multi_core_speedup.md
docs/content/methodology/network_address_translation.md
docs/content/methodology/packet_flow_ordering.md
docs/content/methodology/packet_latency.md
docs/content/methodology/per_thread_resources.md
docs/content/methodology/reconfiguration_tests.md
docs/content/methodology/root_cause_analysis/perpatch_performance_tests.md
docs/content/methodology/suite_generation.md
docs/content/methodology/telemetry.md
docs/content/methodology/terminology.md
docs/content/methodology/trending_methodology/overview.md
docs/content/methodology/trending_methodology/trend_analysis.md
docs/content/methodology/trending_methodology/trend_presentation.md
docs/content/methodology/trex_traffic_generator.md
docs/content/methodology/tunnel_encapsulations.md
docs/content/methodology/vpp_device_functional.md
docs/content/methodology/vpp_forwarding_modes.md
docs/content/methodology/vpp_startup_settings.md
docs/layouts/shortcodes/svg.html [deleted file]

index 2b6593c..a1a70d1 100644 (file)
@@ -11,7 +11,7 @@ services:
       - "cdocs-init"
     volumes:
       - "../docs:/src"
-      - "../csit.infra.dash:/cdash"
+      - "../csit.infra.dash:/csit.infra.dash"
   cdocs-run:
     image: "klakegg/hugo:ext-alpine"
     command: "server --minify"
index 3c02a7e..d845560 100644 (file)
@@ -2,7 +2,7 @@ baseURL = 'https://csit.fd.io/cdocs'
 languageCode = 'en-us'
 title = 'CSIT-DOCS'
 
-publishDir = '../cdash/app/cdocs'
+publishDir = '../csit.infra.dash/app/cdocs'
 
 # (Optional) Set this to true if you use capital letters in file names
 disablePathToLower = true
@@ -35,7 +35,7 @@ path = 'github.com/alex-shpak/hugo-book'
   # (Optional, default true) Controls table of contents visibility on right side of pages.
   # Start and end levels can be controlled with markup.tableOfContents setting.
   # You can also specify this parameter per page in front matter.
-  BookToC = false
+  BookToC = true
 
   # (Optional, default docs) Specify section of content to render as menu
   # You can also set value to "*" to render all sections to menu
index e236b47..5a501fa 100644 (file)
@@ -20,7 +20,7 @@ of the hierarchy, presentation level at the top level and a number of functional
 layers in-between. The current CSIT system design including CSIT framework is
 depicted in the figure below.
 
-{{< svg "static/csit_design_picture.svg" >}}
+{{< figure src="/cdocs/csit_design_picture.svg" title="Steve Francia" >}}
 
 A brief bottom-up description is provided here:
 
index 2933b09..1facccc 100644 (file)
@@ -1,5 +1,4 @@
 ---
-bookToc: false
 title: "PLRsearch"
 weight: 3
 ---
@@ -325,7 +324,7 @@ With that in mind, the apparent narrowness of the interval
 is not a sign of low quality, just a consequence of PLRsearch assuming
 the performance stays constant.
 
-{{< svg "static/PLR_patch.svg" >}}
+{{< figure src="/cdocs/PLR_patch.svg" >}}
 
 #### Vhost
 
@@ -343,7 +342,7 @@ In other words, human only seeing estimates from one fitting function
 would expect narrower end interval, but human seeing the measured loss ratios
 agrees that the interval should be wider than that.
 
-{{< svg "static/PLR_vhost.svg" >}}
+{{< figure src="/cdocs/PLR_vhost.svg" >}}
 
 #### Summary
 
index 8b7b0a4..f4a0af9 100644 (file)
@@ -1,5 +1,4 @@
 ---
-bookToc: false
 title: "GENEVE"
 weight: 21
 ---
index ebcfed2..e7a2571 100644 (file)
@@ -1,5 +1,4 @@
 ---
-bookToc: false
 title: "Telemetry"
 weight: 20
 ---
index 25a1152..229db7d 100644 (file)
@@ -1,5 +1,4 @@
 ---
-bookToc: false
 title: "Terminology"
 weight: 1
 ---
diff --git a/docs/layouts/shortcodes/svg.html b/docs/layouts/shortcodes/svg.html
deleted file mode 100644 (file)
index ea38cb0..0000000
+++ /dev/null
@@ -1,2 +0,0 @@
-{{$svg := .Get 0}}
-{{ $svg  | readFile | safeHTML }}
\ No newline at end of file