Content-Length: 101808 | pFad | http://github.com/postgresml/postgresml/pull/1320.diff

thub.com diff --git a/pgml-cms/docs/introduction/apis/client-sdks/collections.md b/pgml-cms/docs/introduction/apis/client-sdks/collections.md index 2ebc415d5..c5e4df68d 100644 --- a/pgml-cms/docs/introduction/apis/client-sdks/collections.md +++ b/pgml-cms/docs/introduction/apis/client-sdks/collections.md @@ -1,3 +1,7 @@ +--- +description: >- + Organizational building blocks of the SDK. Manage all documents and related chunks, embeddings, tsvectors, and pipelines. +--- # Collections Collections are the organizational building blocks of the SDK. They manage all documents and related chunks, embeddings, tsvectors, and pipelines. diff --git a/pgml-cms/docs/introduction/apis/client-sdks/pipelines.md b/pgml-cms/docs/introduction/apis/client-sdks/pipelines.md index 26305c3c3..1bae53481 100644 --- a/pgml-cms/docs/introduction/apis/client-sdks/pipelines.md +++ b/pgml-cms/docs/introduction/apis/client-sdks/pipelines.md @@ -1,3 +1,7 @@ +--- +description: >- + Pipelines are composed of a model, splitter, and additional optional arguments. +--- # Pipelines Pipelines are composed of a Model, Splitter, and additional optional arguments. Collections can have any number of Pipelines. Each Pipeline is ran everytime documents are upserted. diff --git a/pgml-cms/docs/introduction/apis/client-sdks/tutorials/extractive-question-answering.md b/pgml-cms/docs/introduction/apis/client-sdks/tutorials/extractive-question-answering.md index f934f61d1..78abc3a09 100644 --- a/pgml-cms/docs/introduction/apis/client-sdks/tutorials/extractive-question-answering.md +++ b/pgml-cms/docs/introduction/apis/client-sdks/tutorials/extractive-question-answering.md @@ -1,3 +1,7 @@ +--- +description: >- + JavaScript and Python code snippets for end-to-end question answering. +--- # Extractive Question Answering Here is the documentation for the JavaScript and Python code snippets performing end-to-end question answering: diff --git a/pgml-cms/docs/introduction/apis/client-sdks/tutorials/semantic-search-using-instructor-model.md b/pgml-cms/docs/introduction/apis/client-sdks/tutorials/semantic-search-using-instructor-model.md index 20d0aa756..697845b55 100644 --- a/pgml-cms/docs/introduction/apis/client-sdks/tutorials/semantic-search-using-instructor-model.md +++ b/pgml-cms/docs/introduction/apis/client-sdks/tutorials/semantic-search-using-instructor-model.md @@ -1,3 +1,7 @@ +--- +description: >- + JavaScript and Python code snippets for using instructor models in more advanced search use cases. +--- # Semantic Search using Instructor model This shows using instructor models in the `pgml` SDK for more advanced use cases. diff --git a/pgml-cms/docs/introduction/apis/client-sdks/tutorials/summarizing-question-answering.md b/pgml-cms/docs/introduction/apis/client-sdks/tutorials/summarizing-question-answering.md index 02c9bfaa2..caa7c8a59 100644 --- a/pgml-cms/docs/introduction/apis/client-sdks/tutorials/summarizing-question-answering.md +++ b/pgml-cms/docs/introduction/apis/client-sdks/tutorials/summarizing-question-answering.md @@ -1,3 +1,7 @@ +--- +description: >- + JavaScript and Python code snippets for text summarization. +--- # Summarizing Question Answering Here are the Python and JavaScript examples for text summarization using `pgml` SDK diff --git a/pgml-cms/docs/introduction/apis/sql-extensions/pgml.deploy.md b/pgml-cms/docs/introduction/apis/sql-extensions/pgml.deploy.md index e5c52f793..22dd3733c 100644 --- a/pgml-cms/docs/introduction/apis/sql-extensions/pgml.deploy.md +++ b/pgml-cms/docs/introduction/apis/sql-extensions/pgml.deploy.md @@ -1,3 +1,8 @@ +--- +description: >- + Release trained models when ML quality metrics computed during training improve. Track model deployments over time and rollback if needed. +--- + # pgml.deploy() ## Deployments diff --git a/pgml-cms/docs/introduction/apis/sql-extensions/pgml.embed.md b/pgml-cms/docs/introduction/apis/sql-extensions/pgml.embed.md index 6b392bc26..61f6a6b0e 100644 --- a/pgml-cms/docs/introduction/apis/sql-extensions/pgml.embed.md +++ b/pgml-cms/docs/introduction/apis/sql-extensions/pgml.embed.md @@ -1,3 +1,8 @@ +--- +description: >- + Generate high quality embeddings with faster end-to-end vector operations without an additional vector database. +--- + # pgml.embed() Embeddings are a numeric representation of text. They are used to represent words and sentences as vectors, an array of numbers. Embeddings can be used to find similar pieces of text, by comparing the similarity of the numeric vectors using a distance measure, or they can be used as input features for other machine learning models, since most algorithms can't use text directly. diff --git a/pgml-cms/docs/introduction/apis/sql-extensions/pgml.predict/README.md b/pgml-cms/docs/introduction/apis/sql-extensions/pgml.predict/README.md index 144839180..6566497e5 100644 --- a/pgml-cms/docs/introduction/apis/sql-extensions/pgml.predict/README.md +++ b/pgml-cms/docs/introduction/apis/sql-extensions/pgml.predict/README.md @@ -1,3 +1,8 @@ +--- +description: >- + Batch predict from data in a table. Online predict with parameters passed in a query. Automatically reuse pre-processing steps from training. +--- + # pgml.predict() ## API diff --git a/pgml-cms/docs/introduction/apis/sql-extensions/pgml.train/README.md b/pgml-cms/docs/introduction/apis/sql-extensions/pgml.train/README.md index 6ac7491a9..d00460bfa 100644 --- a/pgml-cms/docs/introduction/apis/sql-extensions/pgml.train/README.md +++ b/pgml-cms/docs/introduction/apis/sql-extensions/pgml.train/README.md @@ -1,8 +1,6 @@ --- description: >- - The training function is at the heart of PostgresML. It's a powerful single - mechanism that can handle many different training tasks which are configurable - with the function parameters. + Pre-process and pull data to train a model using any of 50 different ML algorithms. --- # pgml.train() diff --git a/pgml-cms/docs/introduction/apis/sql-extensions/pgml.transform/README.md b/pgml-cms/docs/introduction/apis/sql-extensions/pgml.transform/README.md index 4d1c30d12..00093f135 100644 --- a/pgml-cms/docs/introduction/apis/sql-extensions/pgml.transform/README.md +++ b/pgml-cms/docs/introduction/apis/sql-extensions/pgml.transform/README.md @@ -1,4 +1,6 @@ --- +description: >- + Perform dozens of state-of-the-art natural language processing (NLP) tasks with thousands of models. Serve with the same Postgres infrastructure. layout: title: visible: true diff --git a/pgml-cms/docs/introduction/apis/sql-extensions/pgml.tune.md b/pgml-cms/docs/introduction/apis/sql-extensions/pgml.tune.md index 65e0e1c21..524b3adfd 100644 --- a/pgml-cms/docs/introduction/apis/sql-extensions/pgml.tune.md +++ b/pgml-cms/docs/introduction/apis/sql-extensions/pgml.tune.md @@ -1,3 +1,8 @@ +--- +description: >- + Fine tune open-source models on your own data. +--- + # pgml.tune() ## Fine Tuning diff --git a/pgml-cms/docs/resources/benchmarks/ggml-quantized-llm-support-for-huggingface-transformers.md b/pgml-cms/docs/resources/benchmarks/ggml-quantized-llm-support-for-huggingface-transformers.md index da53f4702..b6e5c059a 100644 --- a/pgml-cms/docs/resources/benchmarks/ggml-quantized-llm-support-for-huggingface-transformers.md +++ b/pgml-cms/docs/resources/benchmarks/ggml-quantized-llm-support-for-huggingface-transformers.md @@ -1,3 +1,7 @@ +--- +description: >- + Quantization allows PostgresML to fit larger models in less RAM. +--- # GGML Quantized LLM support for Huggingface Transformers diff --git a/pgml-cms/docs/resources/benchmarks/making-postgres-30-percent-faster-in-production.md b/pgml-cms/docs/resources/benchmarks/making-postgres-30-percent-faster-in-production.md index f999591e1..a0581b8e2 100644 --- a/pgml-cms/docs/resources/benchmarks/making-postgres-30-percent-faster-in-production.md +++ b/pgml-cms/docs/resources/benchmarks/making-postgres-30-percent-faster-in-production.md @@ -1,3 +1,7 @@ +--- +description: >- + Anyone who runs Postgres at scale knows that performance comes with trade offs. +--- # Making Postgres 30 Percent Faster in Production Anyone who runs Postgres at scale knows that performance comes with trade offs. The typical playbook is to place a pooler like PgBouncer in front of your database and turn on transaction mode. This makes multiple clients reuse the same server connection, which allows thousands of clients to connect to your database without causing a fork bomb. diff --git a/pgml-cms/docs/resources/benchmarks/million-requests-per-second.md b/pgml-cms/docs/resources/benchmarks/million-requests-per-second.md index 546172c6a..1b7f43985 100644 --- a/pgml-cms/docs/resources/benchmarks/million-requests-per-second.md +++ b/pgml-cms/docs/resources/benchmarks/million-requests-per-second.md @@ -1,3 +1,7 @@ +--- +description: >- + The question "Does it Scale?" has become somewhat of a meme in software engineering. +--- # Million Requests per Second The question "Does it Scale?" has become somewhat of a meme in software engineering. There is a good reason for it though, because most businesses plan for success. If your app, online store, or SaaS becomes popular, you want to be sure that the system powering it can serve all your new customers. diff --git a/pgml-cms/docs/resources/benchmarks/mindsdb-vs-postgresml.md b/pgml-cms/docs/resources/benchmarks/mindsdb-vs-postgresml.md index 211d32922..e56d676a8 100644 --- a/pgml-cms/docs/resources/benchmarks/mindsdb-vs-postgresml.md +++ b/pgml-cms/docs/resources/benchmarks/mindsdb-vs-postgresml.md @@ -1,3 +1,7 @@ +--- +description: >- + Compare two projects that both aim
to provide an SQL interface to ML algorithms and the data they require. +--- # MindsDB vs PostgresML ## Introduction diff --git a/pgml-cms/docs/resources/benchmarks/postgresml-is-8-40x-faster-than-python-http-microservices.md b/pgml-cms/docs/resources/benchmarks/postgresml-is-8-40x-faster-than-python-http-microservices.md index fca4dc98d..73bde7c33 100644 --- a/pgml-cms/docs/resources/benchmarks/postgresml-is-8-40x-faster-than-python-http-microservices.md +++ b/pgml-cms/docs/resources/benchmarks/postgresml-is-8-40x-faster-than-python-http-microservices.md @@ -1,3 +1,7 @@ +--- +description: >- + PostgresML is a simpler alternative to that ever-growing complexity. +--- # PostgresML is 8-40x faster than Python HTTP microservices Machine learning architectures can be some of the most complex, expensive and _difficult_ arenas in modern systems. The number of technologies and the amount of required hardware compete for tightening headcount, hosting, and latency budgets. Unfortunately, the trend in the industry is only getting worse along these lines, with increased usage of state-of-the-art architectures that center around data warehouses, microservices and NoSQL databases. diff --git a/pgml-dashboard/src/api/cms.rs b/pgml-dashboard/src/api/cms.rs index b50677b2b..67525a3f8 100644 --- a/pgml-dashboard/src/api/cms.rs +++ b/pgml-dashboard/src/api/cms.rs @@ -14,7 +14,7 @@ use yaml_rust::YamlLoader; use crate::{ components::{cms::index_link::IndexLink, layouts::marketing::base::Theme, layouts::marketing::Base}, guards::Cluster, - responses::{ResponseOk, Template}, + responses::{Response, ResponseOk, Template}, templates::docs::*, utils::config, }; @@ -48,7 +48,7 @@ lazy_static! { ]) ); static ref CAREERS: Collection = Collection::new("Careers", true, HashMap::from([("a", "b")])); - static ref DOCS: Collection = Collection::new( + pub static ref DOCS: Collection = Collection::new( "Docs", false, HashMap::from([ @@ -249,6 +249,7 @@ impl Document { // MkDocs, gitbook syntax support, e.g. tabs, notes, alerts, etc. crate::utils::markdown::mkdocs(root, &arena).unwrap(); + crate::utils::markdown::wrap_tables(root, &arena).unwrap(); // Style headings like we like them let mut plugins = ComrakPlugins::default(); @@ -312,12 +313,7 @@ impl Collection { NamedFile::open(self.asset_dir.join(path)).await.ok() } - pub async fn get_content( - &self, - mut path: PathBuf, - cluster: &Cluster, - origen: &Origin<'_>, - ) -> Result { + pub async fn get_content_path(&self, mut path: PathBuf, origen: &Origin<'_>) -> (PathBuf, String) { info!("get_content: {} | {path:?}", self.name); let mut redirected = false; @@ -332,7 +328,6 @@ impl Collection { } None => {} }; - let canonical = format!( "https://postgresml.org{}/{}", self.url_root.to_string_lossy(), @@ -343,7 +338,7 @@ impl Collection { } let path = self.root_dir.join(format!("{}.md", path.to_string_lossy())); - self.render(&path, &canonical, cluster).await + (path, canonical) } //github.com/ Create an index of the Collection based on the SUMMARY.md from Gitbook. @@ -356,7 +351,17 @@ impl Collection { let mdast = markdown::to_mdast(&summary_contents, &::markdown::ParseOptions::default()) .unwrap_or_else(|_| panic!("Could not parse summary: {summary_path:?}")); + let mut parent_folder: Option = None; let mut index = Vec::new(); + let indent_level = 1; + + // Docs gets a home link added to the index + match self.name.as_str() { + "Docs" => { + index.push(IndexLink::new("Docs Home", indent_level).href("/docs")); + } + _ => {} + } for node in mdast .children() .unwrap_or_else(|| panic!("Summary has no content: {summary_path:?}")) @@ -364,10 +369,26 @@ impl Collection { { match node { Node::List(list) => { - let mut links = self - .get_sub_links(list) + let links: Vec = self + .get_sub_links(list, indent_level) .unwrap_or_else(|_| panic!("Could not parse list of index links: {summary_path:?}")); - index.append(&mut links); + + let mut out = match parent_folder.as_ref() { + Some(parent_folder) => { + let mut parent = IndexLink::new(parent_folder.as_ref(), 0).href(""); + parent.children = links.clone(); + Vec::from([parent]) + } + None => links, + }; + + index.append(&mut out); + parent_folder = None; + } + Node::Heading(heading) => { + if heading.depth == 2 { + parent_folder = Some(heading.children[0].to_string()); + } } _ => { warn!("Irrelevant content ignored in: {summary_path:?}") @@ -385,7 +406,7 @@ impl Collection { } } - pub fn get_sub_links(&self, list: &markdown::mdast::List) -> anyhow::Result> { + pub fn get_sub_links(&self, list: &markdown::mdast::List, indent_level: i32) -> anyhow::Result> { let mut links = Vec::new(); // SUMMARY.md is a nested List > ListItem > List | Paragraph > Link > Text @@ -396,7 +417,7 @@ impl Collection { match node { Node::List(list) => { let mut link: IndexLink = links.pop().unwrap(); - link.children = self.get_sub_links(list).unwrap(); + link.children = self.get_sub_links(list, indent_level + 1).unwrap(); links.push(link); } Node::Paragraph(paragraph) => { @@ -414,7 +435,7 @@ impl Collection { url = url.replace("README", ""); } let url = self.url_root.join(url); - let parent = IndexLink::new(text.value.as_str()) + let parent = IndexLink::new(text.value.as_str(), indent_level) .href(&url.to_string_lossy()); links.push(parent); } @@ -469,7 +490,9 @@ impl Collection { while children.len() > 0 { let current = children.pop().unwrap(); - urls.push(current.href.clone()); + if current.href.len() > 0 { + urls.push(current.href.clone()); + } for i in (0..current.children.len()).rev() { children.push(¤t.children[i]) @@ -499,16 +522,8 @@ impl Collection { canonical: &str, cluster: &Cluster, ) -> Result { - let user = if cluster.context.user.is_anonymous() { - None - } else { - Some(cluster.context.user.clone()) - }; - match Document::from_path(&path).await { Ok(doc) => { - let index = self.open_index(&doc.path); - let mut layout = crate::templates::Layout::new(&doc.title, Some(cluster)); if let Some(image) = &doc.thumbnail { layout.image(&image); @@ -516,16 +531,8 @@ impl Collection { if let Some(description) = &doc.description { layout.description(description); } - if let Some(user) = &user { - layout.user(user); - } - let layout = layout - .canonical(canonical) - .nav_title(&self.name) - .nav_links(&index) - .toc_links(&doc.toc_links) - .footer(cluster.context.marketing_footer.to_string()); + let layout = layout.canonical(canonical).toc_links(&doc.toc_links); Ok(ResponseOk( layout.render(crate::templates::Article { content: doc.html() }), @@ -543,18 +550,9 @@ impl Collection { "#, ); - if let Some(user) = &user { - layout.user(user); - } - - layout - .nav_links(&self.index) - .nav_title(&self.name) - .footer(cluster.context.marketing_footer.to_string()); - - layout.render(crate::templates::Article { content: doc }); - - Err(crate::responses::NotFound(layout.into())) + Err(crate::responses::NotFound( + layout.render(crate::templates::Article { content: doc }).into(), + )) } } } @@ -594,7 +592,8 @@ async fn get_blog( cluster: &Cluster, origen: &Origin<'_>, ) -> Result { - BLOG.get_content(path, cluster, origen).await + let (doc_file_path, canonical) = BLOG.get_content_path(path.clone(), origen).await; + BLOG.render(&doc_file_path, &canonical, cluster).await } #[get("/careers/", rank = 5)] @@ -603,7 +602,8 @@ async fn get_careers( cluster: &Cluster, origen: &Origin<'_>, ) -> Result { - CAREERS.get_content(path, cluster, origen).await + let (doc_file_path, canonical) = CAREERS.get_content_path(path.clone(), origen).await; + CAREERS.render(&doc_file_path, &canonical, cluster).await } #[get("/docs/", rank = 5)] @@ -612,7 +612,32 @@ async fn get_docs( cluster: &Cluster, origen: &Origin<'_>, ) -> Result { - DOCS.get_content(path, cluster, origen).await + let (doc_file_path, canonical) = DOCS.get_content_path(path.clone(), origen).await; + + match Document::from_path(&doc_file_path).await { + Ok(doc) => { + let index = DOCS.open_index(&doc.path); + + let layout = crate::components::layouts::Docs::new(&doc.title, Some(cluster)) + .index(&index) + .image(&doc.thumbnail) + .canonical(&canonical); + + let page = crate::components::pages::docs::Article::new(&cluster) + .toc_links(&doc.toc_links) + .content(&doc.html()); + + Ok(ResponseOk(layout.render(page))) + } + // Return page not found on bad path + _ => { + let layout = crate::components::layouts::Docs::new("404", Some(cluster)).index(&DOCS.index); + + let page = crate::components::pages::docs::Article::new(&cluster).document_not_found(); + + Err(crate::responses::NotFound(layout.render(page))) + } + } } #[get("/blog")] @@ -633,18 +658,29 @@ async fn blog_landing_page(cluster: &Cluster) -> Result Result { + let index = DOCS.open_index(&PathBuf::from("/docs")); + + let doc_layout = + crate::components::layouts::Docs::new("PostgresML documentation landing page.", Some(cluster)).index(&index); + + let page = crate::components::pages::docs::LandingPage::new(&cluster) + .parse_sections(DOCS.index.clone()) + .await; + + Ok(ResponseOk(doc_layout.render(page))) +} + #[get("/user_guides/", rank = 5)] -async fn get_user_guides( - path: PathBuf, - cluster: &Cluster, - origen: &Origin<'_>, -) -> Result { - DOCS.get_content(path, cluster, origen).await +async fn get_user_guides(path: PathBuf) -> Result { + Ok(Response::redirect(format!("/docs/{}", path.display().to_string()))) } pub fn routes() -> Vec { routes![ blog_landing_page, + docs_landing_page, get_blog, get_blog_asset, get_careers, @@ -871,8 +907,11 @@ This is the end of the markdown let urls = collection.get_all_urls(); for url in urls { - let path = collection.url_to_path(url.as_ref()); - crate::api::cms::Document::from_path(&path).await.unwrap(); + // Don't parse landing page since it is not markdown. + if url != "/docs" { + let path = collection.url_to_path(url.as_ref()); + crate::api::cms::Document::from_path(&path).await.unwrap(); + } } } diff --git a/pgml-dashboard/src/components/accordian/accordian.scss b/pgml-dashboard/src/components/accordian/accordian.scss index dc1a279ce..f2bac7139 100644 --- a/pgml-dashboard/src/components/accordian/accordian.scss +++ b/pgml-dashboard/src/components/accordian/accordian.scss @@ -7,4 +7,34 @@ div[data-controller="accordian"] { overflow: hidden; transition: all 0.3s ease-in-out; } + + .accordian-item { + padding-top: 1rem; + padding-bottom: 1rem; + border-top: solid #{$gray-600} 1px; + } + + .accordian-item:last-child { + border-bottom: solid #{$gray-600} 1px; + } + + .accordian-header h4 { + color: #{$gray-300}; + } + + .accordian-header.selected h4 { + color: #{$gray-100}; + } + + .accordian-header .remove { + display: none; + } + + .accordian-header.selected .add { + display: none; + } + + .accordian-header.selected .remove { + display: block; + } } diff --git a/pgml-dashboard/src/components/accordian/template.html b/pgml-dashboard/src/components/accordian/template.html index 914bac411..5a4259f30 100644 --- a/pgml-dashboard/src/components/accordian/template.html +++ b/pgml-dashboard/src/components/accordian/template.html @@ -4,7 +4,11 @@ <% for i in 0..html_contents.len() { %>
- <%- html_titles[i] %> +
+

<%- html_titles[i] %>

+ add + remove +
<%- html_contents[i] %> diff --git a/pgml-dashboard/src/components/cms/index_link/index_link.scss b/pgml-dashboard/src/components/cms/index_link/index_link.scss new file mode 100644 index 000000000..6913937da --- /dev/null +++ b/pgml-dashboard/src/components/cms/index_link/index_link.scss @@ -0,0 +1,16 @@ +div[data-controller="cms-index-link"] { + .level-1-list { + margin-left: 16px; + } + + .level-2-list, .level-3-list { + margin-left: 4px; + padding-left: 19px; + border-left: 1px solid white + } + + .nav-link:hover { + text-decoration: underline; + text-underline-offset: 2px; + } +} diff --git a/pgml-dashboard/src/components/cms/index_link/mod.rs b/pgml-dashboard/src/components/cms/index_link/mod.rs index a0b8af949..0e4bc74cb 100644 --- a/pgml-dashboard/src/components/cms/index_link/mod.rs +++ b/pgml-dashboard/src/components/cms/index_link/mod.rs @@ -11,11 +11,12 @@ pub struct IndexLink { pub children: Vec, pub open: bool, pub active: bool, + pub level: i32, } impl IndexLink { //github.com/ Create a new documentation link. - pub fn new(title: &str) -> IndexLink { + pub fn new(title: &str, level: i32) -> IndexLink { IndexLink { id: crate::utils::random_string(25), title: title.to_owned(), @@ -23,6 +24,7 @@ impl IndexLink { children: vec![], open: false, active: false, + level, } } diff --git a/pgml-dashboard/src/components/cms/index_link/template.html b/pgml-dashboard/src/components/cms/index_link/template.html index 326395f09..ec9beadac 100644 --- a/pgml-dashboard/src/components/cms/index_link/template.html +++ b/pgml-dashboard/src/components/cms/index_link/template.html @@ -1,6 +1,6 @@ -
- <% +
+ <% let color = if active { "purple" } else { @@ -9,7 +9,18 @@ if children.is_empty() { %> - <%- title %> + <% if level == 1 {%> +
+
+ + <%- title %> + +
+
+ <% } else {%> + <%- title %> + <% } %> + <% } else { let aria = if open { "true" @@ -24,12 +35,30 @@ }; %> - - <%- title %> - expand_more - -
-
+ <% if level == 1 {%> +
+
+ + <%- title %> + +
+ expand_more +
+
+
+ <% } else {%> + + + <%- title %> + +
+ expand_more +
+ + <% } %> + +
+
<% for child in children.into_iter() { %> <%- child.render_once().unwrap() %> <% } %> diff --git a/pgml-dashboard/src/components/inputs/range_group/range_group.scss b/pgml-dashboard/src/components/inputs/range_group/range_group.scss index 1e4c7e308..943600f72 100644 --- a/pgml-dashboard/src/components/inputs/range_group/range_group.scss +++ b/pgml-dashboard/src/components/inputs/range_group/range_group.scss @@ -59,7 +59,7 @@ div[data-controller="inputs-range-group"] { } .tick-text { - color: #{$slate-tint-100}; + color: #{$purple}; &.active-color { color: #{$slate-tint-700}; } diff --git a/pgml-dashboard/src/components/layouts/docs/docs.scss b/pgml-dashboard/src/components/layouts/docs/docs.scss new file mode 100644 index 000000000..e61a18f3b --- /dev/null +++ b/pgml-dashboard/src/components/layouts/docs/docs.scss @@ -0,0 +1,23 @@ +div[data-controller="layouts-docs"] { + $collapsed-left-nav-height: 40px; + + .page-container { + position: relative; + min-height: calc(100vh - $navbar-height); + } + + .drawer-submenu { + @include media-breakpoint-down(lg) { + background-color: #{$gray-800}; + } + } + + .glow-1 { + width: 674.559px; + height: 568.714px; + flex-shrink: 0; + border-radius: 1868.714px; + background: radial-gradient(46.38% 45.17% at 22.72% 36.9%, rgba(57, 210, 231, 0.30) 26.4%, rgba(174, 110, 255, 0.30) 100%); + filter: blur(252.66856384277344px); + } +} diff --git a/pgml-dashboard/src/components/layouts/docs/mod.rs b/pgml-dashboard/src/components/layouts/docs/mod.rs new file mode 100644 index 000000000..a682072ca --- /dev/null +++ b/pgml-dashboard/src/components/layouts/docs/mod.rs @@ -0,0 +1,69 @@ +use crate::components::cms::IndexLink; +use crate::components::layouts::Head; +use crate::guards::Cluster; +use crate::models::User; +use pgml_components::component; +use sailfish::TemplateOnce; + +#[derive(TemplateOnce, Default, Clone)] +#[template(path = "layouts/docs/template.html")] +pub struct Docs { + head: Head, + footer: Option, + user: Option, + content: Option, + index: Vec, +} + +impl Docs { + pub fn new(title: &str, context: Option<&Cluster>) -> Docs { + let (head, footer, user) = match context.as_ref() { + Some(context) => ( + Head::new().title(&title).context(&context.context.head_items), + Some(context.context.marketing_footer.clone()), + Some(context.context.user.clone()), + ), + None => (Head::new().title(&title), None, None), + }; + + Docs { + head, + footer, + user, + ..Default::default() + } + } + + pub fn index(mut self, index: &Vec) -> Docs { + self.index = index.clone(); + self + } + + pub fn image(mut self, image: &Option) -> Docs { + if let Some(image) = image { + self.head = self.head.image(image.as_str()); + } + self + } + + pub fn canonical(mut self, canonical: &str) -> Docs { + self.head = self.head.canonical(canonical); + self + } + + pub fn render(mut self, template: T) -> String + where + T: sailfish::TemplateOnce, + { + self.content = Some(template.render_once().unwrap()); + self.clone().into() + } +} + +impl From for String { + fn from(layout: Docs) -> String { + layout.render_once().unwrap() + } +} + +component!(Docs); diff --git a/pgml-dashboard/src/components/layouts/docs/template.html b/pgml-dashboard/src/components/layouts/docs/template.html new file mode 100644 index 000000000..fa1f327f1 --- /dev/null +++ b/pgml-dashboard/src/components/layouts/docs/template.html @@ -0,0 +1,41 @@ +<% + use crate::components::navigation::navbar::marketing::Marketing as MarketingNavbar; + use crate::components::navigation::left_nav::Docs as IndexNav; +%> + + + + <%+ head %> + +
+ <%+ MarketingNavbar::new(user).style_alt() %> + +
+ <%+ IndexNav::new(&index) %> + + +
+
+
+
+
+
+
+ +
+ <%+ IndexNav::new(&index).for_mobile() %> +
+ +
+ <%- content.unwrap_or_else(|| String::new()) %> +
+
+
+
+
+ +
+ <%- footer.unwrap_or_default() %> +
+ + diff --git a/pgml-dashboard/src/components/layouts/head/template.html b/pgml-dashboard/src/components/layouts/head/template.html index 973cf27a6..4f94ab2a3 100644 --- a/pgml-dashboard/src/components/layouts/head/template.html +++ b/pgml-dashboard/src/components/layouts/head/template.html @@ -70,7 +70,7 @@ - + diff --git a/pgml-dashboard/src/components/layouts/mod.rs b/pgml-dashboard/src/components/layouts/mod.rs index c929358a0..4108da56c 100644 --- a/pgml-dashboard/src/components/layouts/mod.rs +++ b/pgml-dashboard/src/components/layouts/mod.rs @@ -1,6 +1,10 @@ // This file is automatically generated. // You shouldn't modify it manually. +// src/components/layouts/docs +pub mod docs; +pub use docs::Docs; + // src/components/layouts/head pub mod head; pub use head::Head; diff --git a/pgml-dashboard/src/components/mod.rs b/pgml-dashboard/src/components/mod.rs index 17b9c7dbf..aa845f074 100644 --- a/pgml-dashboard/src/components/mod.rs +++ b/pgml-dashboard/src/components/mod.rs @@ -81,6 +81,9 @@ pub use postgres_logo::PostgresLogo; pub mod profile_icon; pub use profile_icon::ProfileIcon; +// src/components/search +pub mod search; + // src/components/sections pub mod sections; diff --git a/pgml-dashboard/src/components/navigation/left_nav/docs/docs.scss b/pgml-dashboard/src/components/navigation/left_nav/docs/docs.scss new file mode 100644 index 000000000..2b3976150 --- /dev/null +++ b/pgml-dashboard/src/components/navigation/left_nav/docs/docs.scss @@ -0,0 +1,63 @@ +div[data-controller="navigation-left-nav-docs"] { + $collapsed-left-nav-height: 40px; + --bs-border-color: #{$gray-600}; + + &.doc-leftnav-container { + background-color: #{$gray-800}; + padding-top: 0px; + border-right: none; + min-width: $docs-left-nav-w; + width: $docs-left-nav-w; + position: relative; + z-index: 0; + display: none; + overflow: hidden; + + @include media-breakpoint-up(xl) { + height: calc(100vh - $navbar-height); + position: sticky; + top: $navbar-height; + display: block; + } + } + + .doc-leftnav { + @extend .navbar; + + border: none; + align-items: start; + background-color: inherit; + + height: 100%; + overflow: auto; + + padding-right: 20px; + box-sizing: border-box; + width: 100%; + } + + .show-scroll { + padding-right: 25px; + @-moz-document url-prefix() { + padding-right: 20px; + } + } + + .btn-primary-alterations { + justify-content: start; + padding: 8px 0px 8px 8px; + border-radius: 4px; + } + + .nav-link { + padding: 8px; + } + + .purple { + color: #{$purple}; + } + + .card { + background-color: #{$gray-900}; + } +} diff --git a/pgml-dashboard/src/components/navigation/left_nav/docs/mod.rs b/pgml-dashboard/src/components/navigation/left_nav/docs/mod.rs new file mode 100644 index 000000000..99606731e --- /dev/null +++ b/pgml-dashboard/src/components/navigation/left_nav/docs/mod.rs @@ -0,0 +1,26 @@ +use crate::components::cms::IndexLink; +use pgml_components::component; +use sailfish::TemplateOnce; + +#[derive(TemplateOnce, Default)] +#[template(path = "navigation/left_nav/docs/template.html")] +pub struct Docs { + index: Vec, + mobile: bool, +} + +impl Docs { + pub fn new(index: &Vec) -> Docs { + Docs { + index: index.clone(), + mobile: false, + } + } + + pub fn for_mobile(mut self) -> Docs { + self.mobile = true; + self + } +} + +component!(Docs); diff --git a/pgml-dashboard/src/components/navigation/left_nav/docs/template.html b/pgml-dashboard/src/components/navigation/left_nav/docs/template.html new file mode 100644 index 000000000..4bacb6f19 --- /dev/null +++ b/pgml-dashboard/src/components/navigation/left_nav/docs/template.html @@ -0,0 +1,76 @@ +<% + fn icon_map(title: &str) -> &str { + match title.to_lowercase().as_str() { + "apis" => "sdk", + "product" => "dashboard", + "use cases" => "account_circle", + "resources" => "school", + _ => "dashboard", + } + } + + fn title(title: String) -> String { + format!(r##" +
+ {} + {} +
+ "##, + icon_map(&title), + title + ) + } +%> + +<% if !mobile { %> +
+ +
+<% } else {%> +
+ +
+<% } %> diff --git a/pgml-dashboard/src/components/navigation/left_nav/mod.rs b/pgml-dashboard/src/components/navigation/left_nav/mod.rs index 00ef95c6b..b4124fe33 100644 --- a/pgml-dashboard/src/components/navigation/left_nav/mod.rs +++ b/pgml-dashboard/src/components/navigation/left_nav/mod.rs @@ -1,6 +1,10 @@ // This file is automatically generated. // You shouldn't modify it manually. +// src/components/navigation/left_nav/docs +pub mod docs; +pub use docs::Docs; + // src/components/navigation/left_nav/web_app pub mod web_app; pub use web_app::WebApp; diff --git a/pgml-dashboard/src/components/navigation/mod.rs b/pgml-dashboard/src/components/navigation/mod.rs index 17ac79074..f47d769f8 100644 --- a/pgml-dashboard/src/components/navigation/mod.rs +++ b/pgml-dashboard/src/components/navigation/mod.rs @@ -13,3 +13,7 @@ pub mod navbar; // src/components/navigation/tabs pub mod tabs; + +// src/components/navigation/toc +pub mod toc; +pub use toc::Toc; diff --git a/pgml-dashboard/src/components/navigation/navbar/marketing/marketing.scss b/pgml-dashboard/src/components/navigation/navbar/marketing/marketing.scss index fe4437e66..6343af6a6 100644 --- a/pgml-dashboard/src/components/navigation/navbar/marketing/marketing.scss +++ b/pgml-dashboard/src/components/navigation/navbar/marketing/marketing.scss @@ -1,9 +1,15 @@ .navbar-marketing-site { @extend .navbar; - &.horizontal { + &.alt-color { + background: #{$gray-800}; + } + + &.horizontal &:not(.alt-color) { background: linear-gradient(180deg, rgba(0, 0, 0, 0.64) -55.68%, rgba(0, 0, 0, 0) 100%); + } + &.horizontal { @include media-breakpoint-up(xl) { height: $navbar-height; --bs-navbar-padding-y: 24px; diff --git a/pgml-dashboard/src/components/navigation/navbar/marketing/mod.rs b/pgml-dashboard/src/components/navigation/navbar/marketing/mod.rs index 333958320..7b8df0f88 100644 --- a/pgml-dashboard/src/components/navigation/navbar/marketing/mod.rs +++ b/pgml-dashboard/src/components/navigation/navbar/marketing/mod.rs @@ -8,6 +8,7 @@ use sailfish::TemplateOnce; pub struct Marketing { pub current_user: Option, pub standalone_dashboard: bool, + pub style_alt: bool, } impl Marketing { @@ -15,8 +16,14 @@ impl Marketing { Marketing { current_user: user, standalone_dashboard: config::standalone_dashboard(), + style_alt: false, } } + + pub fn style_alt(mut self) -> Self { + self.style_alt = true; + self + } } component!(Marketing); diff --git a/pgml-dashboard/src/components/navigation/navbar/marketing/template.html b/pgml-dashboard/src/components/navigation/navbar/marketing/template.html index fb841e8c6..d33d5828f 100644 --- a/pgml-dashboard/src/components/navigation/navbar/marketing/template.html +++ b/pgml-dashboard/src/components/navigation/navbar/marketing/template.html @@ -35,8 +35,8 @@ %>
-