Skip to content

Commit

Permalink
docs: update NextJS content
Browse files Browse the repository at this point in the history
  • Loading branch information
andreancardona committed Sep 19, 2023
1 parent 8c60205 commit e47a6c0
Show file tree
Hide file tree
Showing 7 changed files with 55 additions and 41 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

![Deployment status](https://github.com/carbon-design-system/carbon-website/workflows/Deployment%20status/badge.svg)

This is the [Carbon Design System website](http://www.carbondesignsystem.com). It's built using the [gatsby-theme-carbon](https://gatsby-theme-carbon.now.sh/) with [GatsbyJS](https://www.gatsbyjs.org/).
This is the [Carbon Design System website](http://www.carbondesignsystem.com).
It's built using the [gatsby-theme-carbon](https://gatsby-theme-carbon.now.sh/)
with [GatsbyJS](https://www.gatsbyjs.org/).

## 📂 Structure

Expand All @@ -20,20 +22,25 @@ src
## 👩‍💻 Develop

- 🤝 [Contribution guidelines](.github/CONTRIBUTING.md)
- 📚 [Content and Markdown guidelines](https://gatsby-theme-carbon.now.sh/components/markdown)
- 🗺 [Navigation guidelines](https://gatsby-theme-carbon.now.sh/guides/navigation/sidebar)
- 📚
[Content and Markdown guidelines](https://gatsby-theme-carbon.now.sh/components/markdown)
- 🗺
[Navigation guidelines](https://gatsby-theme-carbon.now.sh/guides/navigation/sidebar)

- `yarn install` – install dependencies
- `yarn dev` – start the development server
- `yarn dev:clean` – use this if you have cache issues
- `lint:js` – lint your JavaScript files
- `format` - run Prettier

If you need more detailed information on how to set up your machine to develop locally, please take a look at our [wiki](https://github.com/carbon-design-system/carbon-website/wiki).
If you need more detailed information on how to set up your machine to develop
locally, please take a look at our
[wiki](https://github.com/carbon-design-system/carbon-website/wiki).

## 🚀 Build

Runing the build command generates all the files and places them in the `public` folder.
Running the build command generates all the files and places them in the
`public` folder.

```
yarn build
Expand Down
2 changes: 1 addition & 1 deletion src/data/nav-items.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
path: /developing/dev-resources/
- title: Angular tutorial
path: /developing/angular-tutorial/overview/
- title: React tutorial
- title: NextJS tutorial
path: /developing/next-tutorial/overview/
- title: Vue tutorial
path: /developing/vue-tutorial/overview/
Expand Down
7 changes: 4 additions & 3 deletions src/pages/all-about-carbon/what-is-carbon.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,10 @@ work and contribute patterns back to the system.
### We support adoption

**We conduct training classes, run meetups, and offer certifications.** We offer
tutorials in Angular, React, and Vue. We run [meetups](/whats-happening/meetups)
and design reviews on a regular basis. We're also available to teach at
conferences, bootcamp labs, and wherever else we're needed.
tutorials in Angular, React using NextJS, and Vue. We run
[meetups](/whats-happening/meetups) and design reviews on a regular basis. We're
also available to teach at conferences, bootcamp labs, and wherever else we're
needed.

**We engage the community.** We strive to be one of the world's best design
systems and we’re
Expand Down
2 changes: 1 addition & 1 deletion src/pages/all-about-carbon/who-uses-carbon.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Here are some ways developers can begin engaging with Carbon.
[design principles](https://www.ibm.com/design/language/).

- Check out a tutorial in your framework of choice
([React](/developing/next-tutorial/overview/),
([React using NextJS](/developing/next-tutorial/overview/),
[Angular (community)](/developing/angular-tutorial/overview/) or
[Vue (community)](/developing/vue-tutorial/overview/)).

Expand Down
9 changes: 5 additions & 4 deletions src/pages/developing/get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,15 @@ as well as our GitHub repos and Storybooks for your framework of choice.

### Take a tutorial

We offer tutorials in Angular, React, and Vue to guide you in creating an app
with the Carbon Design System. We’ll teach you the ins and outs of using Carbon
components, and introduce web development best practices along the way.
We offer tutorials in Angular, React using NextJS, and Vue to guide you in
creating an app with the Carbon Design System. We’ll teach you the ins and outs
of using Carbon components, and introduce web development best practices along
the way.

<Row className="resource-card-group">
<Column colLg={4} colMd={4} noGutterSm>
<ResourceCard
subTitle="React tutorial"
subTitle="React using NextJS tutorial"
href="/developing/next-tutorial/overview"
>

Expand Down
31 changes: 4 additions & 27 deletions src/pages/developing/next-tutorial/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,6 @@ tabs:
]
---

### I am getting an error that says <span className='tutorial-faq-header-code'>`failed to find manifest for cf`</span>. What do I do?

- The 5th step assumes your spaces are in the US South region. To successfully
deploy, you might need to update the region code (e.g.
`api.[REGION].cf.cloud.ibm.com`) to the region where your spaces were created,
or create a space in the US South region.

- If you don't have an org, create one
[here](https://cloud.ibm.com/account/cloud-foundry).
- In the top nav go to Manage > Account > Account resources > Cloud Foundry
orgs
- The name you give it doesn't matter, just take note of the region you
select, and use that region's API endpoint (e.g.
`api.[REGION].cf.cloud.ibm.com`)
- Find regions and endpoints
[here](https://cloud.ibm.com/docs/cloud-foundry-public?topic=cloud-foundry-public-endpoints).

### I am getting an error that says <span className='tutorial-faq-header-code'>`yarn lockfile missing`</span>. How do I fix this?

- This error can occur when the `yarn.lock` file is either missing or differs
Expand All @@ -48,16 +31,6 @@ tabs:
and push up any changes. If this still does not work, ensure your `yarn.lock`
file matches the one at the start of the tutorial step

### When will my PR be reviewed?

- If your PR is passing, it will automatically get approved and closed by a bot.
After it's closed, you can move on to the next step.

- If your PR is failing, try out the troubleshooting tips on this page first to
fix it. If it's still failing, reach out for help in our slack channel
`#carbon-react` or tag `@carbon-design-system/developers` in a comment on your
PR for help.

### How can I show others my completion status?

- Proof of your completion of the tutorial can be seen by filtering the PR list
Expand All @@ -68,3 +41,7 @@ tabs:
link:

- https://github.com/carbon-design-system/carbon-tutorial-nextjs/pulls?q=author%3AYOURUSERNAMEHERE

-It can also be demonstrated by deploying your app. Please see further
documentation
[here](/developing/next-tutorial/step-5#build-for-production-and-deploy).
28 changes: 28 additions & 0 deletions src/pages/developing/next-tutorial/wrapping-up.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Wrapping up
description:
Welcome to Carbon! This tutorial will guide you in creating a Vue app with the
Carbon Design System.
tabs:
['Overview', 'Step 1', 'Step 2', 'Step 3', 'Step 4', 'Step 5', 'Wrapping up']
---

<PageDescription>

Thanks for completing our tutorial and helping us improve it along the way. If
you want to show the world your new skills, you can share your deployed
application and showcase the five pull requests you have completed with the
green `status: approved` label.

</PageDescription>

### How can I show others my completion status?

- Proof of your completion of the tutorial can be seen by filtering the PR list
to show your five PRs with the `status: approved` label.

- You can filter the pull request list to show only pull requests authored by
your username. Replace `YOURUSERNAMEHERE` with your username in the following
link:

- https://github.com/carbon-design-system/carbon-tutorial-nextjs/pulls?q=author%3AYOURUSERNAMEHERE

0 comments on commit e47a6c0

Please sign in to comment.