diff --git a/site/content/blog/example-ckan-2021.md b/site/content/blog/example-ckan-2021.md index e2fb3186e..75a995a74 100644 --- a/site/content/blog/example-ckan-2021.md +++ b/site/content/blog/example-ckan-2021.md @@ -4,7 +4,7 @@ authors: ['Luccas Mateus'] date: 2021-04-20 --- -We have created a full data portal demo using PortalJS all backed by a CKAN instance storing data and metadata, you can see below a screenshot of the homepage and of an individual dataset page. +We have created a full data portal demo using DataHub PortalJS all backed by a CKAN instance storing data and metadata, you can see below a screenshot of the homepage and of an individual dataset page. ![](https://i.imgur.com/ai0VLS4.png) ![](https://i.imgur.com/3RhXOW4.png) @@ -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/portaljs/tree/main/examples/ckan +npx create-next-app -e https://github.com/datopian/datahub/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. diff --git a/site/content/config.js b/site/content/config.js index 326fc20d2..fe307039d 100644 --- a/site/content/config.js +++ b/site/content/config.js @@ -1,7 +1,7 @@ const config = { - title: 'PortalJS - The JavaScript framework for data portals.', + title: 'DataHub PortalJS - The JavaScript framework for data portals.', description: - 'PortalJS is a JavaScript framework for rapidly building rich data portal frontends using a modern frontend approach.', + 'DataHub PortalJS is a JavaScript framework for rapidly building rich data portal frontends using a modern frontend approach.', theme: { default: 'dark', toggleIcon: '/images/theme-button.svg', @@ -11,7 +11,7 @@ const config = { authorUrl: 'https://datopian.com/', navbarTitle: { // logo: "/images/logo.svg", - text: '🌀 PortalJS', + text: '🌀 DataHub PortalJS', // version: "Alpha", }, navLinks: [ @@ -68,8 +68,8 @@ const config = { cardType: 'summary_large_image', }, }, - github: 'https://github.com/datopian/portaljs', - discord: 'https://discord.gg/xfFDMPU9dC', + github: 'https://github.com/datopian/datahub', + discord: 'https://discord.gg/KrRzMKU', tableOfContents: true, analytics: 'G-96GWZHMH57', // editLinkShow: true, diff --git a/site/content/docs/examples/ckan-ssg.md b/site/content/docs/examples/ckan-ssg.md index bc8786f02..dde9139e2 100644 --- a/site/content/docs/examples/ckan-ssg.md +++ b/site/content/docs/examples/ckan-ssg.md @@ -26,7 +26,7 @@ Below are some screenshots: - Create a new app with `create-next-app`: ``` -npx create-next-app --example https://github.com/datopian/portaljs/tree/main/examples/ckan-example +npx create-next-app --example https://github.com/datopian/datahub/tree/main/examples/ckan-example cd ``` @@ -49,7 +49,7 @@ If yo go to any one of those pages by clicking on `More info` you will see somet ## Deployment -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdatopian%2Fportaljs%2Ftree%2Fmain%2Fexamples%2Fckan-example&env=DMS&envDescription=URL%20For%20the%20CKAN%20Backend%20Ex%3A%20https%3A%2F%2Fdemo.dev.datopian.com) +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdatopian%2Fdatahub%2Ftree%2Fmain%2Fexamples%2Fckan-example&env=DMS&envDescription=URL%20For%20the%20CKAN%20Backend%20Ex%3A%20https%3A%2F%2Fdemo.dev.datopian.com) By clicking on this button, you will be redirected to a page which will allow you to clone the content into your own github/gitlab/bitbucket account and automatically deploy everything. @@ -70,6 +70,6 @@ npm run start ## Links -- [Repo](https://github.com/datopian/portaljs/tree/main/examples/ckan-example) +- [Repo](https://github.com/datopian/datahub/tree/main/examples/ckan-example) - [Live Demo](https://ckan-example.portaljs.org) diff --git a/site/content/docs/examples/ckan.md b/site/content/docs/examples/ckan.md index f61db0752..9667f6041 100644 --- a/site/content/docs/examples/ckan.md +++ b/site/content/docs/examples/ckan.md @@ -26,7 +26,7 @@ To get a feel of the project, check out the demo at [live deployment](https://ck Navigate to the directory in which you want to create the project folder and run the following command: ``` -npx create-next-app --example https://github.com/datopian/portaljs/tree/main/examples/ckan +npx create-next-app --example https://github.com/datopian/datahub/tree/main/examples/ckan cd ``` @@ -56,7 +56,7 @@ If you navigate to any of the dataset pages by clicking on the dataset title you ## Deployment -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdatopian%2Fportaljs%2Ftree%2Fmain%2Fexamples%2Fckan&env=DMS&envDescription=URL%20For%20the%20CKAN%20Backend%20Ex%3A%20https%3A%2F%2Fdemo.dev.datopian.com) +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdatopian%2Fdatahub%2Ftree%2Fmain%2Fexamples%2Fckan&env=DMS&envDescription=URL%20For%20the%20CKAN%20Backend%20Ex%3A%20https%3A%2F%2Fdemo.dev.datopian.com) By clicking on this button, you will be redirected to a page which allows you to clone the base project into your own GitHub/GitLab/BitBucket account and automatically deploy it. @@ -158,6 +158,6 @@ Thanks to TypeScript, you can get a list of all the API methods in `@portaljs/ck ## Links -- [Repo](https://github.com/datopian/portaljs/tree/main/examples/ckan) +- [Repo](https://github.com/datopian/datahub/tree/main/examples/ckan) - [Live Demo](http://ckan.portaljs.org/) diff --git a/site/content/docs/examples/example-frictionless-dataset.md.bkp b/site/content/docs/examples/example-frictionless-dataset.md.bkp deleted file mode 100644 index e18185815..000000000 --- a/site/content/docs/examples/example-frictionless-dataset.md.bkp +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "Example: showcase for a single Frictionless dataset" -authors: ['Luccas Mateus'] -date: 2023-04-20 -filetype: blog ---- - -**See the repo:** https://github.com/datopian/portaljs/tree/main/examples/dataset-frictionless - -This example creates a portal/showcase for a single dataset. The dataset should be a [Frictionless dataset (data package)][fd] i.e. there should be a `datapackage.json`. - -[fd]: https://frictionlessdata.io/data-packages/ - -## How to use - -```bash -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 -cd your-portal -yarn #install packages -yarn dev #start app in dev mode -``` - -You should see the demo portal running with the example dataset provided: - - - -### Use your own dataset - -You can try it out with other [Frictionless datasets](https://datahub.io/search). - -In the directory of your portal do: - -```bash -export PORTAL_DATASET_PATH=/path/to/my/dataset -``` - -Then restart the dev server: - -``` -yarn dev -``` - -Check the portal page and it should have updated e.g. like: - -![](https://i.imgur.com/KSEtNF1.png) diff --git a/site/content/docs/examples/github-backed-catalog.md b/site/content/docs/examples/github-backed-catalog.md index 6fa5bc201..af767d8ac 100644 --- a/site/content/docs/examples/github-backed-catalog.md +++ b/site/content/docs/examples/github-backed-catalog.md @@ -33,7 +33,7 @@ Run the following commands: ```bash -npx create-next-app --example https://github.com/datopian/portaljs/tree/main/examples/github-backed-catalog +npx create-next-app --example https://github.com/datopian/datahub/tree/main/examples/github-backed-catalog cd ``` @@ -61,7 +61,7 @@ Congratulations, your new app is now running at http://localhost:3000. ## Deployment -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdatopian%2Fportaljs%2Ftree%2Fmain%2Fexamples%2Fgithub-backed-catalog) +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdatopian%2Fdatahub%2Ftree%2Fmain%2Fexamples%2Fgithub-backed-catalog) By clicking on this button, you will be redirected to a page which will allow you to clone the example into your own GitHub/GitLab/BitBucket account and automatically deploy it. @@ -119,5 +119,5 @@ npm run start ## Links -- [Repo](https://github.com/datopian/portaljs/tree/main/examples/github-backed-catalog) +- [Repo](https://github.com/datopian/datahub/tree/main/examples/github-backed-catalog) - [Live Demo](https://example.portaljs.org) diff --git a/site/content/examples/index.md b/site/content/examples/index.md index ea5236488..2734aab78 100644 --- a/site/content/examples/index.md +++ b/site/content/examples/index.md @@ -2,4 +2,4 @@ For now, see the examples folder in github: -https://github.com/datopian/portaljs/tree/main/examples +https://github.com/datopian/datahub/tree/main/examples diff --git a/site/content/howtos/index.md b/site/content/howtos/index.md index 58f3b7219..081ad11b5 100644 --- a/site/content/howtos/index.md +++ b/site/content/howtos/index.md @@ -11,5 +11,5 @@ description: Learn more about how you can achieve different data portal features - [[howtos/drd|How to create data-rich documents with charts and tables?]] - [[howtos/comments|How to add user comments?]] -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 chat channel on Discord](https://discord.gg/EeyfGrGu4U). +If you have questions about anything related to PortalJS, you're always welcome to ask our community on [GitHub Discussions](https://github.com/datopian/datahub/discussions) or on [our chat channel on Discord](https://discord.gg/EeyfGrGu4U). diff --git a/site/pages/_app.tsx b/site/pages/_app.tsx index 011b72be0..7e214433e 100644 --- a/site/pages/_app.tsx +++ b/site/pages/_app.tsx @@ -50,7 +50,7 @@ function MyApp({ Component, pageProps }) { diff --git a/site/public/scripts/single-dataset-commit.sh b/site/public/scripts/single-dataset-commit.sh index 75bb5e799..4c0ad467e 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/portaljs/tree/main/examples/dataset-frictionless +npx create-next-app portal -e https://github.com/datopian/datahub/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/portaljs/main/site/public/scripts/gh-page-builder-action.yml > .github/workflows/main.yml +curl https://raw.githubusercontent.com/datopian/datahub/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 a209ad94f..3ea56ed6d 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/portaljs/tree/main/examples/dataset-frictionless +npx create-next-app portal -e https://github.com/datopian/datahub/tree/main/examples/dataset-frictionless mkdir portal/public/dataset cp -a ./data portal/public/dataset