From 7684a89f5595c92d594c7b05e9729105f06887a2 Mon Sep 17 00:00:00 2001 From: "Anuar Ustayev (aka Anu)" Date: Sat, 22 Apr 2023 11:58:14 +0600 Subject: [PATCH 1/2] [home/hero][xs]: tweak language on hero element using the same text as on github. --- site/components/Hero.tsx | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/site/components/Hero.tsx b/site/components/Hero.tsx index 286be50f..7cb327a0 100644 --- a/site/components/Hero.tsx +++ b/site/components/Hero.tsx @@ -49,14 +49,11 @@ export function Hero() {

- Portal.JS is a framework for rapidly building rich data portal - frontends using a modern frontend approach. It can be used to - present a single dataset or build a full-scale data - catalog/portal. + Rapidly build rich data portals using a modern frontend framework.

- Get Started + Get started From cceb1b011e47d2a3352a60b4aa2c164695c2fd21 Mon Sep 17 00:00:00 2001 From: anuveyatsu Date: Sat, 22 Apr 2023 12:11:51 +0600 Subject: [PATCH 2/2] [misc][s]: rename Portal.js to PortalJS --- site/README.md | 2 +- site/components/Community.tsx | 4 ++-- site/components/Features.tsx | 4 ++-- site/components/Gallery.tsx | 2 +- site/content/blog/example-ckan-2021.md | 4 ++-- site/content/blog/example-ckan.md | 4 ++-- site/content/blog/example-data-catalog.md | 4 ++-- site/content/config.js | 12 ++++++------ site/content/data-literate/demo.mdx | 4 ++-- .../content/docs/example-frictionless-dataset.md.bkp | 2 +- site/content/docs/index.md | 12 ++++++------ site/content/docs/references.md | 2 +- site/public/scripts/actions/single-dataset-ssg.yml | 2 +- site/public/scripts/single-dataset-commit.sh | 4 ++-- site/public/scripts/single-dataset-no-commit.sh | 2 +- 15 files changed, 32 insertions(+), 32 deletions(-) diff --git a/site/README.md b/site/README.md index 03236a05..75fc2d57 100644 --- a/site/README.md +++ b/site/README.md @@ -1,4 +1,4 @@ -This the Portal.JS website. +This the PortalJS website. It is built on [Next.js](https://nextjs.org/). diff --git a/site/components/Community.tsx b/site/components/Community.tsx index b4a8b061..21e1aee0 100644 --- a/site/components/Community.tsx +++ b/site/components/Community.tsx @@ -77,7 +77,7 @@ export default function Community() {
@@ -89,7 +89,7 @@ export default function Community() { /> diff --git a/site/components/Features.tsx b/site/components/Features.tsx index 274a37bb..79e1bacc 100644 --- a/site/components/Features.tsx +++ b/site/components/Features.tsx @@ -41,10 +41,10 @@ export default function Features() { return (

- How Portal.JS works? + How PortalJS works?

- Portal.JS is built in JavaScript and React on top of the popular Next.js + PortalJS is built in JavaScript and React on top of the popular Next.js framework, assuming a "decoupled" approach where the frontend is a separate service from the backend and interacts with backend(s) via an API. It can be used with any backend and has out of the box support for diff --git a/site/components/Gallery.tsx b/site/components/Gallery.tsx index daf2e890..17800db1 100644 --- a/site/components/Gallery.tsx +++ b/site/components/Gallery.tsx @@ -55,7 +55,7 @@ export default function Gallery() { > Gallery -

Discover what's being powered by Portal.JS

+

Discover what's being powered by PortalJS

{items.map((item) => { return ; diff --git a/site/content/blog/example-ckan-2021.md b/site/content/blog/example-ckan-2021.md index 97dbdd2e..94496de5 100644 --- a/site/content/blog/example-ckan-2021.md +++ b/site/content/blog/example-ckan-2021.md @@ -14,7 +14,7 @@ We have created a full data portal demo using PortalJS all backed by a CKAN inst To create a Portal app, run the following command in your terminal: ```console -npx create-next-app -e https://github.com/datopian/portal.js/tree/main/examples/ckan +npx create-next-app -e https://github.com/datopian/portaljs/tree/main/examples/ckan ``` > NB: Under the hood, this uses the tool called create-next-app, which bootstraps an app for you based on our CKAN example. @@ -75,7 +75,7 @@ For development/debugging purposes, we suggest installing the Chrome extension - ### I18n configuration -Portal.js is configured by default to support both `English` and `French` subpath for language translation. But for subsequent users, this following steps can be used to configure i18n for other languages; +PortalJS is configured by default to support both `English` and `French` subpath for language translation. But for subsequent users, this following steps can be used to configure i18n for other languages; 1. Update `next.config.js`, to add more languages to the i18n locales diff --git a/site/content/blog/example-ckan.md b/site/content/blog/example-ckan.md index 8f5469aa..103f0e8c 100644 --- a/site/content/blog/example-ckan.md +++ b/site/content/blog/example-ckan.md @@ -4,9 +4,9 @@ authors: ['Luccas Mateus'] date: 2023-04-20 --- -Portal.js is an open source project that aims to simplify the creation of web-based data portals, making it easy for users to create and share data-driven applications. +PortalJS is an open source project that aims to simplify the creation of web-based data portals, making it easy for users to create and share data-driven applications. -The ckan-example added to Portal.js is intended to provide users with an easy way to set up a data catalog that can be used to display and share data stores behind a CKAN Backend. With this example, users can quickly set up a web-based portal that allows them to showcase their data and make it accessible to others, all this being done just by adding a simple env variable pointing to a CKAN Deployment. +The ckan-example added to PortalJS is intended to provide users with an easy way to set up a data catalog that can be used to display and share data stores behind a CKAN Backend. With this example, users can quickly set up a web-based portal that allows them to showcase their data and make it accessible to others, all this being done just by adding a simple env variable pointing to a CKAN Deployment. To get a feel of the project, users can check the [live deployment](https://ckan-example.portaljs.org). diff --git a/site/content/blog/example-data-catalog.md b/site/content/blog/example-data-catalog.md index 2dd4f40d..2b5b6648 100644 --- a/site/content/blog/example-data-catalog.md +++ b/site/content/blog/example-data-catalog.md @@ -4,9 +4,9 @@ authors: ['Luccas Mateus'] date: 2023-04-20 --- -Portal.js is an open source project that aims to simplify the creation of web-based data portals, making it easy for users to create and share data-driven applications. +PortalJS is an open source project that aims to simplify the creation of web-based data portals, making it easy for users to create and share data-driven applications. -The simple-example added to Portal.js is intended to provide users with an easy way to set up a data catalog that can be used to display and share data stores stored in GitHub repositories. With this example, users can quickly set up a web-based portal that allows them to showcase their data and make it accessible to others, all this being done thru the configuration of a simple `datasets.json` file. +The simple-example added to PortalJS is intended to provide users with an easy way to set up a data catalog that can be used to display and share data stores stored in GitHub repositories. With this example, users can quickly set up a web-based portal that allows them to showcase their data and make it accessible to others, all this being done thru the configuration of a simple `datasets.json` file. To get a feel of the project, users can check the [live deployment](https://example.portaljs.org). diff --git a/site/content/config.js b/site/content/config.js index 62f40231..ffdd7f6e 100644 --- a/site/content/config.js +++ b/site/content/config.js @@ -1,8 +1,8 @@ const config = { title: - "Portal.JS", + "PortalJS", description: - "Portal.JS is a framework for rapidly building rich data portal frontends using a modern frontend approach. portal.js can be used to present a single dataset or build a full-scale data catalog/portal.", + "PortalJS is a framework for rapidly building rich data portal frontends using a modern frontend approach. PortalJS can be used to present a single dataset or build a full-scale data catalog/portal.", theme: { default: "dark", toggleIcon: "/images/theme-button.svg", @@ -12,7 +12,7 @@ const config = { authorUrl: "https://datopian.com/", navbarTitle: { // logo: "/images/logo.svg", - text: "🌀 Portal.JS", + text: "🌀 PortalJS", // version: "Alpha", }, navLinks: [ @@ -29,14 +29,14 @@ const config = { openGraph: { type: "website", title: - "Portal.JS - Rapidly build rich data portals using a modern frontend framework", + "PortalJS - rapidly build rich data portals using a modern frontend framework.", description: - "Portal.JS is a framework for rapidly building rich data portal frontends using a modern frontend approach. portal.js can be used to present a single dataset or build a full-scale data catalog/portal.", + "PortalJS is a framework for rapidly building rich data portal frontends using a modern frontend approach. PortalJS can be used to present a single dataset or build a full-scale data catalog and portal.", locale: "en_US", images: [ { url: "/homepage-screenshot.png", // TODO - alt: "Portal.JS - Rapidly build rich data portals using a modern frontend framework", + alt: "PortalJS - rapidly build rich data portals using a modern frontend framework.", width: 1280, height: 720, type: "image/jpg", diff --git a/site/content/data-literate/demo.mdx b/site/content/data-literate/demo.mdx index 6833b5f6..63ff21b7 100644 --- a/site/content/data-literate/demo.mdx +++ b/site/content/data-literate/demo.mdx @@ -13,7 +13,7 @@ You can see the raw source of this page here: https://raw.githubusercontent.com/ We can have github-flavored markdown including markdown tables, auto-linked links and checklists: ``` -https://github.com/datopian/portal.js +https://github.com/datopian/portaljs | a | b | |---|---| @@ -23,7 +23,7 @@ https://github.com/datopian/portal.js * [ ] a second thing to do ``` -https://github.com/datopian/portal.js +https://github.com/datopian/portaljs | a | b | |---|---| diff --git a/site/content/docs/example-frictionless-dataset.md.bkp b/site/content/docs/example-frictionless-dataset.md.bkp index 4cb42896..e1818581 100644 --- a/site/content/docs/example-frictionless-dataset.md.bkp +++ b/site/content/docs/example-frictionless-dataset.md.bkp @@ -14,7 +14,7 @@ This example creates a portal/showcase for a single dataset. The dataset should ## How to use ```bash -npx create-next-app -e https://github.com/datopian/portal.js/tree/main/examples/dataset-frictionless +npx create-next-app -e https://github.com/datopian/portaljs/tree/main/examples/dataset-frictionless # choose a name for your portal when prompted e.g. your-portal or go with default my-app # then run it diff --git a/site/content/docs/index.md b/site/content/docs/index.md index e4875fbd..e554ccdc 100644 --- a/site/content/docs/index.md +++ b/site/content/docs/index.md @@ -1,8 +1,8 @@ -# 🌀 Portal.JS: The JavaScript framework for data portals +# 🌀 PortalJS: The JavaScript framework for data portals -🌀 Portal.JS is a framework for rapidly building rich data portal frontends using a modern frontend approach. Portal.JS can be used to present a single dataset or build a full-scale data catalog/portal. +🌀 PortalJS is a framework for rapidly building rich data portal frontends using a modern frontend approach. PortalJS can be used to present a single dataset or build a full-scale data catalog/portal. -Built in JavaScript and React on top of the popular [Next.js](https://nextjs.com/) framework. Portal.JS assumes a "decoupled" approach where the frontend is a separate service from the backend and interacts with backend(s) via an API. It can be used with any backend and has out of the box support for [CKAN](https://ckan.org/). +Built in JavaScript and React on top of the popular [Next.js](https://nextjs.com/) framework. PortalJS assumes a "decoupled" approach where the frontend is a separate service from the backend and interacts with backend(s) via an API. It can be used with any backend and has out of the box support for [CKAN](https://ckan.org/). ## Features @@ -24,15 +24,15 @@ Built in JavaScript and React on top of the popular [Next.js](https://nextjs.com ### Examples -You can check out the following examples built with Portal.js. +You can check out the following examples built with PortalJS. * [Data catalog with data coming from CKAN](/docs/example-ckan) * [Simple data catalog](/docs/example-data-catalog) -> The [`examples` directory](https://github.com/datopian/portal.js/tree/main/examples) is regularly updated with different portal examples. +> The [`examples` directory](https://github.com/datopian/portaljs/tree/main/examples) is regularly updated with different portal examples. ## Getting Help -If you have questions about anything related to Portal.js, you're always welcome to ask our community on [GitHub Discussions](https://github.com/datopian/portal.js/discussions) or on our [Discord server](https://discord.gg/An7Bu5x8). +If you have questions about anything related to PortalJS, you're always welcome to ask our community on [GitHub Discussions](https://github.com/datopian/portaljs/discussions) or on our [Discord server](https://discord.gg/An7Bu5x8). diff --git a/site/content/docs/references.md b/site/content/docs/references.md index 1d66cd21..24c83081 100644 --- a/site/content/docs/references.md +++ b/site/content/docs/references.md @@ -1,6 +1,6 @@ # Concepts and Terms -In this section, we explain some of the terms and concepts used throughtout the portal.js documentation. +In this section, we explain some of the terms and concepts used throughtout the PortalJS documentation. > Some of these concepts are part of official specs, and when appropriate, we'll link to the sources where you can get more details. diff --git a/site/public/scripts/actions/single-dataset-ssg.yml b/site/public/scripts/actions/single-dataset-ssg.yml index 83ec12e6..c62a69ab 100644 --- a/site/public/scripts/actions/single-dataset-ssg.yml +++ b/site/public/scripts/actions/single-dataset-ssg.yml @@ -20,7 +20,7 @@ jobs: env: PORTAL_REPO_NAME: ${{ secrets.PORTAL_REPO_NAME }} run: | - curl https://raw.githubusercontent.com/datopian/portal.js/main/site/public/scripts/single-dataset-no-commit.sh > portal.sh + curl https://raw.githubusercontent.com/datopian/portaljs/main/site/public/scripts/single-dataset-no-commit.sh > portal.sh git config --local user.email "$(git log --format='%ae' HEAD^!)" git config --local user.name "$(git log --format='%an' HEAD^!)" source ./portal.sh diff --git a/site/public/scripts/single-dataset-commit.sh b/site/public/scripts/single-dataset-commit.sh index 76e37f5d..75bb5e79 100644 --- a/site/public/scripts/single-dataset-commit.sh +++ b/site/public/scripts/single-dataset-commit.sh @@ -1,7 +1,7 @@ #!/bin/bash rm -rf portal mkdir -p portal -npx create-next-app portal -e https://github.com/datopian/portal.js/tree/main/examples/dataset-frictionless +npx create-next-app portal -e https://github.com/datopian/portaljs/tree/main/examples/dataset-frictionless mkdir portal/public/dataset cp -a ./data portal/public/dataset @@ -12,7 +12,7 @@ PORTAL_DATASET_PATH=$PWD"/portal/public/dataset" export PORTAL_DATASET_PATH mkdir -p .github && mkdir -p .github/workflows && touch .github/workflows/main.yml -curl https://raw.githubusercontent.com/datopian/portal.js/main/site/public/scripts/gh-page-builder-action.yml > .github/workflows/main.yml +curl https://raw.githubusercontent.com/datopian/portaljs/main/site/public/scripts/gh-page-builder-action.yml > .github/workflows/main.yml cd portal assetPrefix='"/'$PORTAL_REPO_NAME'/"' diff --git a/site/public/scripts/single-dataset-no-commit.sh b/site/public/scripts/single-dataset-no-commit.sh index 7ca36ae5..a209ad94 100644 --- a/site/public/scripts/single-dataset-no-commit.sh +++ b/site/public/scripts/single-dataset-no-commit.sh @@ -3,7 +3,7 @@ git checkout -b gh-pages git rm -r --cached . rm -rf portal mkdir -p portal -npx create-next-app portal -e https://github.com/datopian/portal.js/tree/main/examples/dataset-frictionless +npx create-next-app portal -e https://github.com/datopian/portaljs/tree/main/examples/dataset-frictionless mkdir portal/public/dataset cp -a ./data portal/public/dataset