diff options
Diffstat (limited to 'docs')
34 files changed, 5 insertions, 38 deletions
diff --git a/docs/config.toml b/docs/config.toml index 3c02a7ee88..d8455609d2 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -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 diff --git a/docs/content/introduction/design.md b/docs/content/introduction/design.md index e236b47d6f..5a501faeba 100644 --- a/docs/content/introduction/design.md +++ b/docs/content/introduction/design.md @@ -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: diff --git a/docs/content/methodology/access_control_lists.md b/docs/content/methodology/access_control_lists.md index 6e8502f543..9767d3f86a 100644 --- a/docs/content/methodology/access_control_lists.md +++ b/docs/content/methodology/access_control_lists.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Access Control Lists" weight: 12 --- diff --git a/docs/content/methodology/data_plane_throughput/data_plane_throughput.md b/docs/content/methodology/data_plane_throughput/data_plane_throughput.md index efcf1c5ffb..7ff1d38d17 100644 --- a/docs/content/methodology/data_plane_throughput/data_plane_throughput.md +++ b/docs/content/methodology/data_plane_throughput/data_plane_throughput.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Data Plane Throughput" weight: 1 --- diff --git a/docs/content/methodology/data_plane_throughput/mlrsearch.md b/docs/content/methodology/data_plane_throughput/mlrsearch.md index 7b3b445b4f..73039c9b02 100644 --- a/docs/content/methodology/data_plane_throughput/mlrsearch.md +++ b/docs/content/methodology/data_plane_throughput/mlrsearch.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "MLRsearch" weight: 2 --- diff --git a/docs/content/methodology/data_plane_throughput/mrr_throughput.md b/docs/content/methodology/data_plane_throughput/mrr_throughput.md index 2d895704a1..076946fb66 100644 --- a/docs/content/methodology/data_plane_throughput/mrr_throughput.md +++ b/docs/content/methodology/data_plane_throughput/mrr_throughput.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "MRR Throughput" weight: 4 --- diff --git a/docs/content/methodology/data_plane_throughput/plrsearch.md b/docs/content/methodology/data_plane_throughput/plrsearch.md index 2933b09b6b..1facccc63b 100644 --- a/docs/content/methodology/data_plane_throughput/plrsearch.md +++ b/docs/content/methodology/data_plane_throughput/plrsearch.md @@ -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 diff --git a/docs/content/methodology/dut_state_considerations.md b/docs/content/methodology/dut_state_considerations.md index bfd7ef6977..55e408f5f2 100644 --- a/docs/content/methodology/dut_state_considerations.md +++ b/docs/content/methodology/dut_state_considerations.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "DUT state considerations" weight: 6 --- diff --git a/docs/content/methodology/generic_segmentation_offload.md b/docs/content/methodology/generic_segmentation_offload.md index abfab03e16..ddb19ba826 100644 --- a/docs/content/methodology/generic_segmentation_offload.md +++ b/docs/content/methodology/generic_segmentation_offload.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Generic Segmentation Offload" weight: 15 --- diff --git a/docs/content/methodology/geneve.md b/docs/content/methodology/geneve.md index 8b7b0a48b0..f4a0af92e7 100644 --- a/docs/content/methodology/geneve.md +++ b/docs/content/methodology/geneve.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "GENEVE" weight: 21 --- diff --git a/docs/content/methodology/hoststack_testing/quicudpip_with_vppecho.md b/docs/content/methodology/hoststack_testing/quicudpip_with_vppecho.md index f1d654380e..c7d57a51b3 100644 --- a/docs/content/methodology/hoststack_testing/quicudpip_with_vppecho.md +++ b/docs/content/methodology/hoststack_testing/quicudpip_with_vppecho.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "QUIC/UDP/IP with vpp_echo" weight: 1 --- diff --git a/docs/content/methodology/hoststack_testing/tcpip_with_iperf3.md b/docs/content/methodology/hoststack_testing/tcpip_with_iperf3.md index 23e1aea997..7baa88ab50 100644 --- a/docs/content/methodology/hoststack_testing/tcpip_with_iperf3.md +++ b/docs/content/methodology/hoststack_testing/tcpip_with_iperf3.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "TCP/IP with iperf3" weight: 2 --- diff --git a/docs/content/methodology/hoststack_testing/udpip_with_iperf3.md b/docs/content/methodology/hoststack_testing/udpip_with_iperf3.md index 9ff3bc42f1..01ddf61269 100644 --- a/docs/content/methodology/hoststack_testing/udpip_with_iperf3.md +++ b/docs/content/methodology/hoststack_testing/udpip_with_iperf3.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "UDP/IP with iperf3" weight: 3 --- diff --git a/docs/content/methodology/hoststack_testing/vsap_ab_with_nginx.md b/docs/content/methodology/hoststack_testing/vsap_ab_with_nginx.md index c954722d91..2dc4d2b7f9 100644 --- a/docs/content/methodology/hoststack_testing/vsap_ab_with_nginx.md +++ b/docs/content/methodology/hoststack_testing/vsap_ab_with_nginx.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "VSAP ab with nginx" weight: 4 --- diff --git a/docs/content/methodology/internet_protocol_security_ipsec.md b/docs/content/methodology/internet_protocol_security_ipsec.md index 5cee667868..711004f2c0 100644 --- a/docs/content/methodology/internet_protocol_security_ipsec.md +++ b/docs/content/methodology/internet_protocol_security_ipsec.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Internet Protocol Security (IPsec)" weight: 11 --- diff --git a/docs/content/methodology/multi_core_speedup.md b/docs/content/methodology/multi_core_speedup.md index e0ff7e446a..c0c9ae2570 100644 --- a/docs/content/methodology/multi_core_speedup.md +++ b/docs/content/methodology/multi_core_speedup.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Multi-Core Speedup" weight: 13 --- diff --git a/docs/content/methodology/network_address_translation.md b/docs/content/methodology/network_address_translation.md index a46ea9af30..ef341dc892 100644 --- a/docs/content/methodology/network_address_translation.md +++ b/docs/content/methodology/network_address_translation.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Network Address Translation" weight: 7 --- diff --git a/docs/content/methodology/packet_flow_ordering.md b/docs/content/methodology/packet_flow_ordering.md index b5f6122502..d2b3bfb90c 100644 --- a/docs/content/methodology/packet_flow_ordering.md +++ b/docs/content/methodology/packet_flow_ordering.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Packet Flow Ordering" weight: 9 --- diff --git a/docs/content/methodology/packet_latency.md b/docs/content/methodology/packet_latency.md index 9d1cdd6f99..fd7c0e00e8 100644 --- a/docs/content/methodology/packet_latency.md +++ b/docs/content/methodology/packet_latency.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Packet Latency" weight: 8 --- diff --git a/docs/content/methodology/per_thread_resources.md b/docs/content/methodology/per_thread_resources.md index a1d65a873f..cd862fa824 100644 --- a/docs/content/methodology/per_thread_resources.md +++ b/docs/content/methodology/per_thread_resources.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Per Thread Resources" weight: 2 --- diff --git a/docs/content/methodology/reconfiguration_tests.md b/docs/content/methodology/reconfiguration_tests.md index 2d1f222674..837535526d 100644 --- a/docs/content/methodology/reconfiguration_tests.md +++ b/docs/content/methodology/reconfiguration_tests.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Reconfiguration Tests" weight: 16 --- diff --git a/docs/content/methodology/root_cause_analysis/perpatch_performance_tests.md b/docs/content/methodology/root_cause_analysis/perpatch_performance_tests.md index 9b01a80ef2..900ea0b874 100644 --- a/docs/content/methodology/root_cause_analysis/perpatch_performance_tests.md +++ b/docs/content/methodology/root_cause_analysis/perpatch_performance_tests.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Per-patch performance tests" weight: 1 --- diff --git a/docs/content/methodology/suite_generation.md b/docs/content/methodology/suite_generation.md index 351e70a7d1..4fa9dee0ce 100644 --- a/docs/content/methodology/suite_generation.md +++ b/docs/content/methodology/suite_generation.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Suite Generation" weight: 19 --- diff --git a/docs/content/methodology/telemetry.md b/docs/content/methodology/telemetry.md index ebcfed2728..e7a2571573 100644 --- a/docs/content/methodology/telemetry.md +++ b/docs/content/methodology/telemetry.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Telemetry" weight: 20 --- diff --git a/docs/content/methodology/terminology.md b/docs/content/methodology/terminology.md index 25a1152138..229db7d145 100644 --- a/docs/content/methodology/terminology.md +++ b/docs/content/methodology/terminology.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Terminology" weight: 1 --- diff --git a/docs/content/methodology/trending_methodology/overview.md b/docs/content/methodology/trending_methodology/overview.md index 5e28ccdb2d..90d8a2507c 100644 --- a/docs/content/methodology/trending_methodology/overview.md +++ b/docs/content/methodology/trending_methodology/overview.md @@ -1,5 +1,4 @@ --- -bookFlatSection: true title: "Overview" weight: 1 --- diff --git a/docs/content/methodology/trending_methodology/trend_analysis.md b/docs/content/methodology/trending_methodology/trend_analysis.md index f1ff06baeb..7f1870f577 100644 --- a/docs/content/methodology/trending_methodology/trend_analysis.md +++ b/docs/content/methodology/trending_methodology/trend_analysis.md @@ -1,5 +1,4 @@ --- -bookFlatSection: true title: "Trending Analysis" weight: 2 --- diff --git a/docs/content/methodology/trending_methodology/trend_presentation.md b/docs/content/methodology/trending_methodology/trend_presentation.md index ac5137ac1a..4c58589a0b 100644 --- a/docs/content/methodology/trending_methodology/trend_presentation.md +++ b/docs/content/methodology/trending_methodology/trend_presentation.md @@ -1,5 +1,4 @@ --- -bookFlatSection: true title: "Trending Presentation" weight: 3 --- diff --git a/docs/content/methodology/trex_traffic_generator.md b/docs/content/methodology/trex_traffic_generator.md index 1e394d9e50..4f62d91c47 100644 --- a/docs/content/methodology/trex_traffic_generator.md +++ b/docs/content/methodology/trex_traffic_generator.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "TRex Traffic Generator" weight: 5 --- diff --git a/docs/content/methodology/tunnel_encapsulations.md b/docs/content/methodology/tunnel_encapsulations.md index dfb09b8519..52505b7efb 100644 --- a/docs/content/methodology/tunnel_encapsulations.md +++ b/docs/content/methodology/tunnel_encapsulations.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "Tunnel Encapsulations" weight: 10 --- diff --git a/docs/content/methodology/vpp_device_functional.md b/docs/content/methodology/vpp_device_functional.md index 2f273fe3ea..2bad5973b6 100644 --- a/docs/content/methodology/vpp_device_functional.md +++ b/docs/content/methodology/vpp_device_functional.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "VPP_Device Functional" weight: 18 --- diff --git a/docs/content/methodology/vpp_forwarding_modes.md b/docs/content/methodology/vpp_forwarding_modes.md index 85284a3ec4..1cc199c607 100644 --- a/docs/content/methodology/vpp_forwarding_modes.md +++ b/docs/content/methodology/vpp_forwarding_modes.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "VPP Forwarding Modes" weight: 3 --- diff --git a/docs/content/methodology/vpp_startup_settings.md b/docs/content/methodology/vpp_startup_settings.md index b682129d12..6e40091a6c 100644 --- a/docs/content/methodology/vpp_startup_settings.md +++ b/docs/content/methodology/vpp_startup_settings.md @@ -1,5 +1,4 @@ --- -bookToc: false title: "VPP Startup Settings" weight: 17 --- diff --git a/docs/layouts/shortcodes/svg.html b/docs/layouts/shortcodes/svg.html deleted file mode 100644 index ea38cb0c6b..0000000000 --- a/docs/layouts/shortcodes/svg.html +++ /dev/null @@ -1,2 +0,0 @@ -{{$svg := .Get 0}} -{{ $svg | readFile | safeHTML }}
\ No newline at end of file |