From 9e2dfa7067e4f31e4d236ecd1c39942a8e41ec0b Mon Sep 17 00:00:00 2001 From: matoval Date: Fri, 18 Oct 2024 14:44:56 -0700 Subject: [PATCH 01/11] Add qlog doc --- docs/source/user_guide/configuration_options.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/source/user_guide/configuration_options.rst b/docs/source/user_guide/configuration_options.rst index 74f6c2e06..abc4be9c0 100644 --- a/docs/source/user_guide/configuration_options.rst +++ b/docs/source/user_guide/configuration_options.rst @@ -88,6 +88,20 @@ Please be aware that using payload tracing can potentially reveal sensitive info log-level: level: debug +^^^ +Qlog +^^^ + +* - Variable + - Description + - Type +* - QLOGDIR + - environment variable to the directory path where logs will be stored + - string + + Qlogs allows greater visibility in the Receptors mesh network. Set the QLOGDIR environment variable to the directory path where logs will be stored. Creating a new directory may help organize qlogs. + Once logs are created they can be viewed by uploading the logs to + ^^^^ Node ^^^^ From e7567eb0a62b8d21cc01b2f833f6ec5857baa12f Mon Sep 17 00:00:00 2001 From: matoval Date: Fri, 18 Oct 2024 14:46:31 -0700 Subject: [PATCH 02/11] Fix header --- docs/source/user_guide/configuration_options.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/user_guide/configuration_options.rst b/docs/source/user_guide/configuration_options.rst index abc4be9c0..3256e53bd 100644 --- a/docs/source/user_guide/configuration_options.rst +++ b/docs/source/user_guide/configuration_options.rst @@ -88,9 +88,9 @@ Please be aware that using payload tracing can potentially reveal sensitive info log-level: level: debug -^^^ +^^^^ Qlog -^^^ +^^^^ * - Variable - Description From fcbaec8a6cf4e60a6d95ff8e58836ca1f9c84086 Mon Sep 17 00:00:00 2001 From: matoval Date: Fri, 18 Oct 2024 14:47:46 -0700 Subject: [PATCH 03/11] Fix qlog table --- docs/source/user_guide/configuration_options.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/user_guide/configuration_options.rst b/docs/source/user_guide/configuration_options.rst index 3256e53bd..174d44501 100644 --- a/docs/source/user_guide/configuration_options.rst +++ b/docs/source/user_guide/configuration_options.rst @@ -92,6 +92,7 @@ Please be aware that using payload tracing can potentially reveal sensitive info Qlog ^^^^ +.. list-table:: Qlog * - Variable - Description - Type From 6f4176482dea10fe7da02dd62b4fdfdb2a74ba12 Mon Sep 17 00:00:00 2001 From: matoval Date: Fri, 18 Oct 2024 14:49:40 -0700 Subject: [PATCH 04/11] Fix table styles --- docs/source/user_guide/configuration_options.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/user_guide/configuration_options.rst b/docs/source/user_guide/configuration_options.rst index 174d44501..6274ff9e3 100644 --- a/docs/source/user_guide/configuration_options.rst +++ b/docs/source/user_guide/configuration_options.rst @@ -93,6 +93,9 @@ Qlog ^^^^ .. list-table:: Qlog + :header-rows: 1 + :widths: auto + * - Variable - Description - Type From fe06fbd39254ac897d312ce024f299eada6e764a Mon Sep 17 00:00:00 2001 From: matoval Date: Fri, 18 Oct 2024 14:50:42 -0700 Subject: [PATCH 05/11] fix indention --- docs/source/user_guide/configuration_options.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/user_guide/configuration_options.rst b/docs/source/user_guide/configuration_options.rst index 6274ff9e3..657b2b08e 100644 --- a/docs/source/user_guide/configuration_options.rst +++ b/docs/source/user_guide/configuration_options.rst @@ -93,8 +93,8 @@ Qlog ^^^^ .. list-table:: Qlog - :header-rows: 1 - :widths: auto + :header-rows: 1 + :widths: auto * - Variable - Description From b64734566bd1245ebf5a0d5018a41183690a5244 Mon Sep 17 00:00:00 2001 From: matoval Date: Fri, 18 Oct 2024 14:51:37 -0700 Subject: [PATCH 06/11] Fix qlog table --- docs/source/user_guide/configuration_options.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/user_guide/configuration_options.rst b/docs/source/user_guide/configuration_options.rst index 657b2b08e..392a1678d 100644 --- a/docs/source/user_guide/configuration_options.rst +++ b/docs/source/user_guide/configuration_options.rst @@ -96,12 +96,12 @@ Qlog :header-rows: 1 :widths: auto -* - Variable - - Description - - Type -* - QLOGDIR - - environment variable to the directory path where logs will be stored - - string + * - Variable + - Description + - Type + * - QLOGDIR + - environment variable to the directory path where logs will be stored + - string Qlogs allows greater visibility in the Receptors mesh network. Set the QLOGDIR environment variable to the directory path where logs will be stored. Creating a new directory may help organize qlogs. Once logs are created they can be viewed by uploading the logs to From bc640e9fe154e29a3983a0260dd97c14a94db966 Mon Sep 17 00:00:00 2001 From: matoval Date: Fri, 18 Oct 2024 14:52:49 -0700 Subject: [PATCH 07/11] Fix description --- docs/source/user_guide/configuration_options.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/user_guide/configuration_options.rst b/docs/source/user_guide/configuration_options.rst index 392a1678d..4b635bca5 100644 --- a/docs/source/user_guide/configuration_options.rst +++ b/docs/source/user_guide/configuration_options.rst @@ -103,8 +103,8 @@ Qlog - environment variable to the directory path where logs will be stored - string - Qlogs allows greater visibility in the Receptors mesh network. Set the QLOGDIR environment variable to the directory path where logs will be stored. Creating a new directory may help organize qlogs. - Once logs are created they can be viewed by uploading the logs to +Qlogs allows greater visibility in the Receptors mesh network. Set the QLOGDIR environment variable to the directory path where logs will be stored. Creating a new directory may help organize qlogs. +Once logs are created they can be viewed by uploading the logs to ^^^^ Node From ef59e9f525176f9d04f703d09e52e173c416cd55 Mon Sep 17 00:00:00 2001 From: matoval Date: Mon, 21 Oct 2024 17:41:36 -0700 Subject: [PATCH 08/11] Update qlog docs --- docs/source/user_guide/configuration_options.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/source/user_guide/configuration_options.rst b/docs/source/user_guide/configuration_options.rst index 4b635bca5..331eb57e9 100644 --- a/docs/source/user_guide/configuration_options.rst +++ b/docs/source/user_guide/configuration_options.rst @@ -104,7 +104,15 @@ Qlog - string Qlogs allows greater visibility in the Receptors mesh network. Set the QLOGDIR environment variable to the directory path where logs will be stored. Creating a new directory may help organize qlogs. -Once logs are created they can be viewed by uploading the logs to +Once logs are created they can be viewed using (qvis)[https://github.com/quiclog/qvis] + +#### Run qvis locally: +- Git clone qvis repo +- `cd visualizations` +- `run npm install` +- `npm run serve` +- Qvis is now served on port 8080 +- Upload qlogs to qvis and navigate to Sequence ^^^^ Node From 1c85a99ee7a6c936119e9d1cc72d1a52f8954a19 Mon Sep 17 00:00:00 2001 From: matoval Date: Mon, 21 Oct 2024 17:43:07 -0700 Subject: [PATCH 09/11] Update sub-title --- docs/source/user_guide/configuration_options.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/source/user_guide/configuration_options.rst b/docs/source/user_guide/configuration_options.rst index 331eb57e9..018c17539 100644 --- a/docs/source/user_guide/configuration_options.rst +++ b/docs/source/user_guide/configuration_options.rst @@ -106,7 +106,10 @@ Qlog Qlogs allows greater visibility in the Receptors mesh network. Set the QLOGDIR environment variable to the directory path where logs will be stored. Creating a new directory may help organize qlogs. Once logs are created they can be viewed using (qvis)[https://github.com/quiclog/qvis] -#### Run qvis locally: +---------------- +Run qvis locally: +---------------- + - Git clone qvis repo - `cd visualizations` - `run npm install` From 0bd1663c0b024341a9842157b5d8384ef02814b9 Mon Sep 17 00:00:00 2001 From: matoval Date: Mon, 21 Oct 2024 17:44:47 -0700 Subject: [PATCH 10/11] update inline code --- docs/source/user_guide/configuration_options.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/user_guide/configuration_options.rst b/docs/source/user_guide/configuration_options.rst index 018c17539..683a35d1a 100644 --- a/docs/source/user_guide/configuration_options.rst +++ b/docs/source/user_guide/configuration_options.rst @@ -111,9 +111,9 @@ Run qvis locally: ---------------- - Git clone qvis repo -- `cd visualizations` -- `run npm install` -- `npm run serve` +- ``cd visualizations`` +- ``run npm install`` +- ``npm run serve`` - Qvis is now served on port 8080 - Upload qlogs to qvis and navigate to Sequence From 5f5656f1cab01ca311f0ff8cc72454fdbcd274cd Mon Sep 17 00:00:00 2001 From: matoval Date: Wed, 23 Oct 2024 09:05:28 -0700 Subject: [PATCH 11/11] Fix title --- docs/source/user_guide/configuration_options.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/user_guide/configuration_options.rst b/docs/source/user_guide/configuration_options.rst index 683a35d1a..ad921693c 100644 --- a/docs/source/user_guide/configuration_options.rst +++ b/docs/source/user_guide/configuration_options.rst @@ -106,9 +106,9 @@ Qlog Qlogs allows greater visibility in the Receptors mesh network. Set the QLOGDIR environment variable to the directory path where logs will be stored. Creating a new directory may help organize qlogs. Once logs are created they can be viewed using (qvis)[https://github.com/quiclog/qvis] ----------------- +----------------- Run qvis locally: ----------------- +----------------- - Git clone qvis repo - ``cd visualizations``