[epic] Portal Docs v1.0 incl tutorials

[rufuspollock]

My sense is that we have:

• Home page introducing the project and what it does and key features (core README)
• One major tutorial (like Next.js "learn"): start with a single dataset app (where dataset is simplest possible e.g. a README + CSV)
• Showcase: here's what you can build
• Examples that extend beyond that e.g.
  • Portal with Frictionless dataset
  • Portal with Github datasets
  • Portal with CKAN
• Reference docs: e.g. key components and there APIs, etc => this can be in README / code to start with

Job Stories

What is the key job story?

• How do i showcase and publish my individual dataset on github pages?
• How do I build my CKAN-based data catalog frontend using datahub/portal.js

Roadmap 🚧 2023-05-01

• Learn experience: from a single data file to a mini-catalog (to deployed?) (markdown files, SSG) [docs][epic] Intro Tutorial ("learn" experience) v1 (2023) #800
• Build a data portal with multiple datasets.
  • I can do it Git-backed
  • (Optional) S3-backed
  • (Optional) CKAN-backed
• I can build an insightful dataset page. Eg, write about what you can do with MDX an show some cool examples, eg https://demo.datahub.io/@datasets/oil-prices

Acceptance

• Tutorial on getting started with Portal and present a single simple dataset locally
  • I know how to share my Portal publicly
• There are examples for
  • Creating a portal with Portal.js for CKAN
  • ...

Tasks

• Home page introducing the project and what it does and key features (core README)
• One major tutorial (like Next.js "learn"): start with a single dataset app (where dataset is simplest possible e.g. a README + CSV)
  • v0.1 Installation Getting Started v0.1 #531 + install dataset-frictionless DONE
  • v1.0 of Tutorial [docs] Portal.js Tutorial ("learn" experience) v1 (2021 - OBSOLETE) #562
• Showcase: here's what you can build
• Examples that extend beyond that e.g.
  • Basic CKAN example - just show datasets (with search?) Update CKAN example to use new portaljs components (CKAN example 2021) #563
  • Complex CKAN example: with search, with orgs Update CKAN example to use new portaljs components (CKAN example 2021) #563 (?)
  • Basic Github example
  • Portal with content coming from a CMS
• Reference docs: e.g. key components and there APIs, etc => this can be in README / code to start with

Analysis

Learn from NextJS

TODO: check out how next.js used to be e.g. 2y ago. IIRC reference docs were in README.md of github repo and there was the nextjs.org learn ... (see e.g. https://github.com/vercel/next.js/tree/e4a94acd96527885781e5fffa75c870bfded84fc)

DONE. Checked way back machine e.g.

2018 - http://web.archive.org/web/20180428210110/https://nextjs.org/learn

2019 - http://web.archive.org/web/20190331100140/https://nextjs.org/learn/basics/getting-started/