From 60bc04497bc6f1061e7590b10f47ac79d1abe125 Mon Sep 17 00:00:00 2001 From: Seung Park Date: Tue, 15 Apr 2025 13:16:53 -0400 Subject: [PATCH 1/8] add sample composable tutorial --- source/composable-tutorials.txt | 62 +++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 source/composable-tutorials.txt diff --git a/source/composable-tutorials.txt b/source/composable-tutorials.txt new file mode 100644 index 0000000..8029f4f --- /dev/null +++ b/source/composable-tutorials.txt @@ -0,0 +1,62 @@ +===================================== +Example page with Composable Tutorial +===================================== + +.. composable-tutorial:: + :options: interface, language, deployment-type, cloud-provider + :defaults: driver, nodejs, atlas, gcp + + .. selected-content:: + :selections: driver, nodejs, atlas, gcp + + This content will only be shown when the selections are as follows: + Interface - Drivers + Language - NodeJS + Deployment Type - Atlas + Cloud Provider - GCP + + .. selected-content:: + :selections: driver, c, atlas, gcp + + This content will only be shown when the selections are as follows: + Interface - Drivers + Language - C + Deployment Type - atlas + Cloud Provider - GCP + + .. selected-content:: + :selections: driver, cpp, atlas, aws + + This content will only be shown when the selections are as follows: + Interface - Drivers + Language - CPP + Deployment Type - atlas + Cloud Provider - AWS + + + .. selected-content:: + :selections: atlas-admin-api, None, atlas, gcp + + This content will only be shown when the selections are as follows: + Interface - Atlas Admin API + Deployment Type - atlas + Cloud Provider - GCP + + + .. selected-content:: + :selections: atlas-admin-api, None, atlas, aws + + This content will only be shown when the selections are as follows: + Interface - Atlas Admin API + Deployment Type - Atlas + Cloud Provider - AWS + + + + .. selected-content:: + :selections: atlas-admin-api, None, self, aws + + This content will only be shown when the selections are as follows: + Interface - Atlas Admin API + Deployment Type - self + Cloud Provider - AWS \ No newline at end of file From 8b6457bf0d89da34b7a87f3f39032b2ab793961e Mon Sep 17 00:00:00 2001 From: Seung Park Date: Tue, 15 Apr 2025 14:32:04 -0400 Subject: [PATCH 2/8] attempt using a heading --- source/composable-tutorials.txt | 65 ++++++++++++++++++++------------- 1 file changed, 40 insertions(+), 25 deletions(-) diff --git a/source/composable-tutorials.txt b/source/composable-tutorials.txt index 8029f4f..8641521 100644 --- a/source/composable-tutorials.txt +++ b/source/composable-tutorials.txt @@ -10,53 +10,68 @@ Example page with Composable Tutorial :selections: driver, nodejs, atlas, gcp This content will only be shown when the selections are as follows: - Interface - Drivers - Language - NodeJS - Deployment Type - Atlas - Cloud Provider - GCP + * Interface - Drivers + * Language - NodeJS + * Deployment Type - Atlas + * Cloud Provider - GCP .. selected-content:: :selections: driver, c, atlas, gcp This content will only be shown when the selections are as follows: - Interface - Drivers - Language - C - Deployment Type - atlas - Cloud Provider - GCP + * Interface - Drivers + * Language - C + * Deployment Type - atlas + * Cloud Provider - GCP .. selected-content:: :selections: driver, cpp, atlas, aws This content will only be shown when the selections are as follows: - Interface - Drivers - Language - CPP - Deployment Type - atlas - Cloud Provider - AWS + * Interface - Drivers + * Language - CPP + * Deployment Type - atlas + * Cloud Provider - AWS .. selected-content:: :selections: atlas-admin-api, None, atlas, gcp This content will only be shown when the selections are as follows: - Interface - Atlas Admin API - Deployment Type - atlas - Cloud Provider - GCP - + * Interface - Atlas Admin API + * Deployment Type - atlas + * Cloud Provider - GCP .. selected-content:: :selections: atlas-admin-api, None, atlas, aws This content will only be shown when the selections are as follows: - Interface - Atlas Admin API - Deployment Type - Atlas - Cloud Provider - AWS - - + * Interface - Atlas Admin API + * Deployment Type - Atlas + * Cloud Provider - AWS .. selected-content:: :selections: atlas-admin-api, None, self, aws - This content will only be shown when the selections are as follows: - Interface - Atlas Admin API - Deployment Type - self - Cloud Provider - AWS \ No newline at end of file + There can't be a title here + --------------------------- + + This content will only be shown when the selections are as follows: + * Interface - Atlas Admin API + * Deployment Type - self + * Cloud Provider - AWS + + This content will only be shown when the selections are as follows: + * Interface - Atlas Admin API + * Deployment Type - self + * Cloud Provider - AWS + + This content will only be shown when the selections are as follows: + * Interface - Atlas Admin API + * Deployment Type - self + * Cloud Provider - AWS + + This content will only be shown when the selections are as follows: + * Interface - Atlas Admin API + * Deployment Type - self + * Cloud Provider - AWS \ No newline at end of file From 8a1cc886759d1da174b4057c9fd4f2cc723b69ca Mon Sep 17 00:00:00 2001 From: Seung Park Date: Tue, 15 Apr 2025 14:33:02 -0400 Subject: [PATCH 3/8] remove whitespace --- source/composable-tutorials.txt | 44 ++++++++++++++++----------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/source/composable-tutorials.txt b/source/composable-tutorials.txt index 8641521..c2d565b 100644 --- a/source/composable-tutorials.txt +++ b/source/composable-tutorials.txt @@ -53,25 +53,25 @@ Example page with Composable Tutorial .. selected-content:: :selections: atlas-admin-api, None, self, aws - There can't be a title here - --------------------------- - - This content will only be shown when the selections are as follows: - * Interface - Atlas Admin API - * Deployment Type - self - * Cloud Provider - AWS - - This content will only be shown when the selections are as follows: - * Interface - Atlas Admin API - * Deployment Type - self - * Cloud Provider - AWS - - This content will only be shown when the selections are as follows: - * Interface - Atlas Admin API - * Deployment Type - self - * Cloud Provider - AWS - - This content will only be shown when the selections are as follows: - * Interface - Atlas Admin API - * Deployment Type - self - * Cloud Provider - AWS \ No newline at end of file + There can't be a title here + --------------------------- + + This content will only be shown when the selections are as follows: + * Interface - Atlas Admin API + * Deployment Type - self + * Cloud Provider - AWS + + This content will only be shown when the selections are as follows: + * Interface - Atlas Admin API + * Deployment Type - self + * Cloud Provider - AWS + + This content will only be shown when the selections are as follows: + * Interface - Atlas Admin API + * Deployment Type - self + * Cloud Provider - AWS + + This content will only be shown when the selections are as follows: + * Interface - Atlas Admin API + * Deployment Type - self + * Cloud Provider - AWS \ No newline at end of file From 7c7a155755ccaa774509b5298f2ca6eb2300bcaf Mon Sep 17 00:00:00 2001 From: Seung Park Date: Tue, 15 Apr 2025 14:35:23 -0400 Subject: [PATCH 4/8] Update composable-tutorials.txt --- source/composable-tutorials.txt | 44 ++++++++++++++++----------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/source/composable-tutorials.txt b/source/composable-tutorials.txt index c2d565b..cc05964 100644 --- a/source/composable-tutorials.txt +++ b/source/composable-tutorials.txt @@ -53,25 +53,25 @@ Example page with Composable Tutorial .. selected-content:: :selections: atlas-admin-api, None, self, aws - There can't be a title here - --------------------------- - - This content will only be shown when the selections are as follows: - * Interface - Atlas Admin API - * Deployment Type - self - * Cloud Provider - AWS - - This content will only be shown when the selections are as follows: - * Interface - Atlas Admin API - * Deployment Type - self - * Cloud Provider - AWS - - This content will only be shown when the selections are as follows: - * Interface - Atlas Admin API - * Deployment Type - self - * Cloud Provider - AWS - - This content will only be shown when the selections are as follows: - * Interface - Atlas Admin API - * Deployment Type - self - * Cloud Provider - AWS \ No newline at end of file + There can't be a title here + --------------------------- + + This content will only be shown when the selections are as follows: + * Interface - Atlas Admin API + * Deployment Type - self + * Cloud Provider - AWS + + This content will only be shown when the selections are as follows: + * Interface - Atlas Admin API + * Deployment Type - self + * Cloud Provider - AWS + + This content will only be shown when the selections are as follows: + * Interface - Atlas Admin API + * Deployment Type - self + * Cloud Provider - AWS + + This content will only be shown when the selections are as follows: + * Interface - Atlas Admin API + * Deployment Type - self + * Cloud Provider - AWS From 78cd5596af76fc63aff7b0119fbe3bf726b93f8f Mon Sep 17 00:00:00 2001 From: Seung Park Date: Thu, 17 Apr 2025 13:34:51 -0400 Subject: [PATCH 5/8] update content --- source/composable-tutorials.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/composable-tutorials.txt b/source/composable-tutorials.txt index cc05964..f38b2e2 100644 --- a/source/composable-tutorials.txt +++ b/source/composable-tutorials.txt @@ -53,8 +53,8 @@ Example page with Composable Tutorial .. selected-content:: :selections: atlas-admin-api, None, self, aws - There can't be a title here - --------------------------- + This is a title under selected content + -------------------------------------- This content will only be shown when the selections are as follows: * Interface - Atlas Admin API From 4ffd307e4241ce55886e65651d2b8aac7e73dcb1 Mon Sep 17 00:00:00 2001 From: Seung Park Date: Tue, 6 May 2025 14:40:26 -0400 Subject: [PATCH 6/8] test data for DOP-5507 --- snooty.toml | 54 +++++++++++++++++++++++++++++++++ source/composable-tutorials.txt | 48 ++++++++++++++++++----------- 2 files changed, 85 insertions(+), 17 deletions(-) diff --git a/snooty.toml b/snooty.toml index 659e947..68dd28e 100644 --- a/snooty.toml +++ b/snooty.toml @@ -23,3 +23,57 @@ kafka-connector = ["v1.9", "v1.8", "v1.7", "v1.6", "v1.5", "v1.4", "v1.3", "v1.2 golang = ["v1.10", "v1.9", "v1.8", "v1.7"] java = ["v4.6", "v4.5", "v4.4", "v4.3"] php-library = ["v1.15", "v1.13", "v1.12", "v1.11", "v1.10", "v1.9", "v1.8", "v1.7", "v1.6", "v1.5", "v1.4", "v1.3", "v1.2", "v1.1"] + + +[[composables]] +id = "operator" +title = "Operator" +default = "queryString" +options = [ + {id = "queryString", title = "queryString"}, + {id = "autocomplete", title = "autocomplete"} +] + +# merging existing +[[composables]] +id = "cloud-provider" +title = "Operator" +default = "queryString" +options = [ + {id = "aws", title = "new aws title"}, + {id = "aws2", title = "aws2"} +] + +# overwrite dependencies +[[composables]] +id = "language" +title = "Language" +default = "cpp" +options = [] + +# [[composables]] +# # missing id +# # missing title +# default = "queryString" +# options = [ +# {id = "queryString", title = "queryString"}, +# {id = "autocomplete", title = "autocomplete"} +# ] + + +# [[composables]] +# id = "operator2" +# title = "Operator2" +# # works without default +# options = [ +# {id = "queryString", title = "queryString"}, +# {id = "autocomplete", title = "autocomplete"} +# ] + +# [[composables]] +# id = "operator3" +# title = "Operator3" +# options = [ +# {id = "queryString"}, # missing title +# {title = "autocomplete"} # missing id +# ] diff --git a/source/composable-tutorials.txt b/source/composable-tutorials.txt index f38b2e2..2e360f3 100644 --- a/source/composable-tutorials.txt +++ b/source/composable-tutorials.txt @@ -3,55 +3,55 @@ Example page with Composable Tutorial ===================================== .. composable-tutorial:: - :options: interface, language, deployment-type, cloud-provider - :defaults: driver, nodejs, atlas, gcp + :options: interface, language, deployment-type, operator + :defaults: driver, nodejs, atlas, queryString .. selected-content:: - :selections: driver, nodejs, atlas, gcp + :selections: driver, nodejs, atlas, queryString This content will only be shown when the selections are as follows: * Interface - Drivers * Language - NodeJS * Deployment Type - Atlas - * Cloud Provider - GCP + * Operator (custom snooty.toml) - queryString .. selected-content:: - :selections: driver, c, atlas, gcp + :selections: driver, c, atlas, queryString This content will only be shown when the selections are as follows: * Interface - Drivers * Language - C * Deployment Type - atlas - * Cloud Provider - GCP + * Operator (custom snooty.toml) - queryString .. selected-content:: - :selections: driver, cpp, atlas, aws + :selections: driver, cpp, atlas, autocomplete This content will only be shown when the selections are as follows: * Interface - Drivers * Language - CPP * Deployment Type - atlas - * Cloud Provider - AWS + * Operator (custom snooty.toml) - autocomplete .. selected-content:: - :selections: atlas-admin-api, None, atlas, gcp + :selections: atlas-admin-api, None, atlas, queryString This content will only be shown when the selections are as follows: * Interface - Atlas Admin API * Deployment Type - atlas - * Cloud Provider - GCP + * Operator (custom snooty.toml) - queryString .. selected-content:: - :selections: atlas-admin-api, None, atlas, aws + :selections: atlas-admin-api, None, atlas, autocomplete This content will only be shown when the selections are as follows: * Interface - Atlas Admin API * Deployment Type - Atlas - * Cloud Provider - AWS + * Operator (custom snooty.toml) - autocomplete .. selected-content:: - :selections: atlas-admin-api, None, self, aws + :selections: atlas-admin-api, None, self, autocomplete This is a title under selected content -------------------------------------- @@ -59,19 +59,33 @@ Example page with Composable Tutorial This content will only be shown when the selections are as follows: * Interface - Atlas Admin API * Deployment Type - self - * Cloud Provider - AWS + * Operator (custom snooty.toml) - autocomplete This content will only be shown when the selections are as follows: * Interface - Atlas Admin API * Deployment Type - self - * Cloud Provider - AWS + * Operator (custom snooty.toml) - autocomplete This content will only be shown when the selections are as follows: * Interface - Atlas Admin API * Deployment Type - self - * Cloud Provider - AWS + * Operator (custom snooty.toml) - autocomplete This content will only be shown when the selections are as follows: * Interface - Atlas Admin API * Deployment Type - self - * Cloud Provider - AWS + * Operator (custom snooty.toml) - autocomplete + + .. io-code-block:: + :copyable: true + + .. input:: + :language: shell + + QUERY_EMBEDDING.length + + .. output:: + :language: shell + + 1536 + From 141b0c1269083e7a6ef5cb22e82dc21f6c6c05d1 Mon Sep 17 00:00:00 2001 From: Seung Park Date: Tue, 6 May 2025 15:03:18 -0400 Subject: [PATCH 7/8] minor comment update --- snooty.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/snooty.toml b/snooty.toml index 68dd28e..1ecc2fa 100644 --- a/snooty.toml +++ b/snooty.toml @@ -44,7 +44,7 @@ options = [ {id = "aws2", title = "aws2"} ] -# overwrite dependencies +# overwrite default [[composables]] id = "language" title = "Language" From 8af70e6d7c82a9fec80cd877f4e573af6553d96f Mon Sep 17 00:00:00 2001 From: Seung Park Date: Fri, 9 May 2025 10:13:24 -0400 Subject: [PATCH 8/8] test changes for DOP-5589 --- snooty.toml | 4 ++-- source/composable-tutorials.txt | 6 ++++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/snooty.toml b/snooty.toml index 1ecc2fa..e6602a4 100644 --- a/snooty.toml +++ b/snooty.toml @@ -38,13 +38,13 @@ options = [ [[composables]] id = "cloud-provider" title = "Operator" -default = "queryString" +default = "aws" options = [ {id = "aws", title = "new aws title"}, {id = "aws2", title = "aws2"} ] -# overwrite default +# overwrite dependencies [[composables]] id = "language" title = "Language" diff --git a/source/composable-tutorials.txt b/source/composable-tutorials.txt index 2e360f3..e5a9bc2 100644 --- a/source/composable-tutorials.txt +++ b/source/composable-tutorials.txt @@ -2,6 +2,12 @@ Example page with Composable Tutorial ===================================== +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + .. composable-tutorial:: :options: interface, language, deployment-type, operator :defaults: driver, nodejs, atlas, queryString