From 5cc312b55ba993a59ef775134f014941a9c66d1a Mon Sep 17 00:00:00 2001 From: Luccas Mateus de Medeiros Gomes Date: Sat, 6 May 2023 14:31:48 -0300 Subject: [PATCH 1/5] [docs][m] - components api section --- site/content/docs/components-api.md | 13 +++++++++++++ site/content/docs/deploying-your-portaljs-app.md | 2 +- site/content/docs/sidebar.json | 4 ++++ 3 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 site/content/docs/components-api.md diff --git a/site/content/docs/components-api.md b/site/content/docs/components-api.md new file mode 100644 index 00000000..0d75237a --- /dev/null +++ b/site/content/docs/components-api.md @@ -0,0 +1,13 @@ +# Components API + +You now have a basic data catalog running, the next step would be to dig into the components library. PortalJS supports the following components by default: + +- `` A searchable catalog that will index a list of datasets and allow for contextual searching + filters. +- `` A simple component that allows the creation of an opinionated line chart without the need to go deep into charting standards +- `` A wrapper around the [Vega specification](https://vega.github.io/vega/) that allows you to build pretty much any kind of chart imaginable +- `` A wrapper around the [Vega Lite specification](https://vega.github.io/vega-lite/) which allows for a more concise grammar than Vega around the building of charts. +- `` is an easy-to-use table component with built-in pagination, search, and sorting. + +For more details on those please refer to our [Storybook Documentation](https://storybook.portaljs.org/), which contains all the details on how to use them. + + diff --git a/site/content/docs/deploying-your-portaljs-app.md b/site/content/docs/deploying-your-portaljs-app.md index 33e4f433..26a39bb3 100644 --- a/site/content/docs/deploying-your-portaljs-app.md +++ b/site/content/docs/deploying-your-portaljs-app.md @@ -52,5 +52,5 @@ https://developers.cloudflare.com/pages/framework-guides/deploy-a-nextjs-site/#d Note that you don't have to change anything - just follow the steps, choosing the repository you created. - + diff --git a/site/content/docs/sidebar.json b/site/content/docs/sidebar.json index c2649c50..3e7f1941 100644 --- a/site/content/docs/sidebar.json +++ b/site/content/docs/sidebar.json @@ -21,6 +21,10 @@ { "name": "Deploying your PortalJS app", "href": "/docs/deploying-your-portaljs-app" + }, + { + "name": "Components API", + "href": "/docs/components-api" } ] }, From 7150150db0ad9d474539f482ea488d75cdb747d2 Mon Sep 17 00:00:00 2001 From: "Anuar Ustayev (aka Anu)" Date: Sun, 7 May 2023 11:04:34 +0600 Subject: [PATCH 2/5] [sidebar][xs]: moved the components page to higher level. --- site/content/docs/sidebar.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/site/content/docs/sidebar.json b/site/content/docs/sidebar.json index 3e7f1941..1a1561ec 100644 --- a/site/content/docs/sidebar.json +++ b/site/content/docs/sidebar.json @@ -21,13 +21,13 @@ { "name": "Deploying your PortalJS app", "href": "/docs/deploying-your-portaljs-app" - }, - { - "name": "Components API", - "href": "/docs/components-api" } ] }, + { + "name": "Components", + "href": "/docs/components" + }, { "name": "Examples", "children": [ From 9fe08fcd1bed53f5b6f33d0a11afcd903488937a Mon Sep 17 00:00:00 2001 From: "Anuar Ustayev (aka Anu)" Date: Sun, 7 May 2023 11:05:21 +0600 Subject: [PATCH 3/5] [docs][xs]: no need to link to the next tutorial as it's irrelevant to getting started series. --- site/content/docs/deploying-your-portaljs-app.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/site/content/docs/deploying-your-portaljs-app.md b/site/content/docs/deploying-your-portaljs-app.md index 26a39bb3..89bc3fc6 100644 --- a/site/content/docs/deploying-your-portaljs-app.md +++ b/site/content/docs/deploying-your-portaljs-app.md @@ -51,6 +51,3 @@ To deploy your PortalJS app to Cloudflare Pages, follow this guide: https://developers.cloudflare.com/pages/framework-guides/deploy-a-nextjs-site/#deploy-with-cloudflare-pages-1 Note that you don't have to change anything - just follow the steps, choosing the repository you created. - - - From 53b64b81c9b4b7e0d9e304507219e76b736a50f7 Mon Sep 17 00:00:00 2001 From: "Anuar Ustayev (aka Anu)" Date: Sun, 7 May 2023 11:06:53 +0600 Subject: [PATCH 4/5] [docs][xs]: bring back prev link to prev tutorial as was removed by mistake. --- site/content/docs/deploying-your-portaljs-app.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/site/content/docs/deploying-your-portaljs-app.md b/site/content/docs/deploying-your-portaljs-app.md index 89bc3fc6..9367ba4a 100644 --- a/site/content/docs/deploying-your-portaljs-app.md +++ b/site/content/docs/deploying-your-portaljs-app.md @@ -51,3 +51,5 @@ To deploy your PortalJS app to Cloudflare Pages, follow this guide: https://developers.cloudflare.com/pages/framework-guides/deploy-a-nextjs-site/#deploy-with-cloudflare-pages-1 Note that you don't have to change anything - just follow the steps, choosing the repository you created. + + From 8b511232903f9f1a7909359956941346107af504 Mon Sep 17 00:00:00 2001 From: "Anuar Ustayev (aka Anu)" Date: Sun, 7 May 2023 11:10:26 +0600 Subject: [PATCH 5/5] [docs][s]: update and rename components-api.md to components.md --- site/content/docs/{components-api.md => components.md} | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) rename site/content/docs/{components-api.md => components.md} (63%) diff --git a/site/content/docs/components-api.md b/site/content/docs/components.md similarity index 63% rename from site/content/docs/components-api.md rename to site/content/docs/components.md index 0d75237a..cb761af4 100644 --- a/site/content/docs/components-api.md +++ b/site/content/docs/components.md @@ -1,13 +1,9 @@ -# Components API +# Components -You now have a basic data catalog running, the next step would be to dig into the components library. PortalJS supports the following components by default: +PortalJS comes with a library of components that provides essential pieces for your data portal. The best way to explore the components is to look at our [Storybook](https://storybook.portaljs.org/) that contains all the details on how to use them. Below is a quick summary of existing components today: - `` A searchable catalog that will index a list of datasets and allow for contextual searching + filters. - `` A simple component that allows the creation of an opinionated line chart without the need to go deep into charting standards - `` A wrapper around the [Vega specification](https://vega.github.io/vega/) that allows you to build pretty much any kind of chart imaginable - `` A wrapper around the [Vega Lite specification](https://vega.github.io/vega-lite/) which allows for a more concise grammar than Vega around the building of charts. - `
` is an easy-to-use table component with built-in pagination, search, and sorting. - -For more details on those please refer to our [Storybook Documentation](https://storybook.portaljs.org/), which contains all the details on how to use them. - -