knight/datahub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

merge: implement tutorial improvements based on feedback

Browse Source 
**Issue:** https://github.com/datopian/portaljs/issues/839

## Changes

- Update info about required Node version
- Remove mention to automatic reload from docs
This commit is contained in:
João Demenech 2023-05-08 17:20:36 -03:00 committed by GitHub
commit 6705bc1e2d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
site/content/docs/index.md
View File

@ -8,7 +8,7 @@ If you have questions about anything related to PortalJS, you're always welcome
### Prerequisites ### Prerequisites
- Node.js 14.18.0 or newer - Node v16.20.0 LTS or Node.js 18.16.0 LTS (recommended)
- MacOS, Windows (including WSL), and Linux are supported - MacOS, Windows (including WSL), and Linux are supported
### Create a PortalJS app ### Create a PortalJS app
@ -20,7 +20,7 @@ npx create-next-app my-data-portal --example https://github.com/datopian/portalj
``` ```
> [!tip] > [!tip]
> You may have noticed we used the command create-next-app. That’s because PortalJS is built on the awesome NextJS react javascript framework. That’s mean you can do everything you do with NextJS with PortalJS. Check out their docs to learn more. > You may have noticed we used the command create-next-app. That’s because PortalJS is built on the awesome NextJS react javascript framework. This means you can do everything you do with NextJS with PortalJS. Check out their docs to learn more.
### Run the development server ### Run the development server
@ -47,7 +47,7 @@ Let’s try editing the starter page.
- Find the text that says “My Dataset” and change it to “My Awesome Dataset”. - Find the text that says “My Dataset” and change it to “My Awesome Dataset”.
- Save the file. - Save the file.
As soon as you save the file, the browser automatically updates the page with the new text: After refreshing the page, you should see the new text:
<img src="/assets/docs/editing-the-page-1.png" /> <img src="/assets/docs/editing-the-page-1.png" />