Skip to content

Commit

Permalink
fix: fixed the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
guidari committed Sep 19, 2023
1 parent dbd2c8c commit 8c60205
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 64 deletions.
2 changes: 1 addition & 1 deletion src/pages/developing/next-tutorial/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ build:
<Preview
height="400"
title="Carbon Tutorial"
src="https://v11-next-step-5--carbon-tutorial-nextjs.netlify.app"
src="https://carbon-tutorial-nextjs.vercel.app/"
frameborder="no"
allowtransparency="true"
allowfullscreen="true"
Expand Down
7 changes: 4 additions & 3 deletions src/pages/developing/next-tutorial/step-1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,14 @@ to navigate between pages.

## Preview

A [preview](https://v11-next-step-2--carbon-tutorial.netlify.app) of what you
will build:
A
[preview](https://carbon-tutorial-nextjs-nrt4ljsgl-carbon-design-system.vercel.app/)
of what you will build:

<Preview
height="200"
title="Carbon Next Tutorial Step 1"
src="https://v11-next-step-2--carbon-tutorial.netlify.app"
src="https://carbon-tutorial-nextjs-nrt4ljsgl-carbon-design-system.vercel.app/"
frameborder="no"
allowtransparency="true"
allowfullscreen="true"
Expand Down
7 changes: 4 additions & 3 deletions src/pages/developing/next-tutorial/step-2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,14 @@ various Carbon components.

## Preview

A [preview](https://v11-next-step-3--carbon-tutorial.netlify.app) of what you'll
build:
A
[preview](https://carbon-tutorial-nextjs-huv7un4ex-carbon-design-system.vercel.app/)
of what you'll build:

<Preview
height="400"
title="Carbon Next Tutorial Step 2"
src="https://v11-next-step-3--carbon-tutorial.netlify.app"
src="https://carbon-tutorial-nextjs-huv7un4ex-carbon-design-system.vercel.app/"
frameborder="no"
allowtransparency="true"
allowfullscreen="true"
Expand Down
7 changes: 4 additions & 3 deletions src/pages/developing/next-tutorial/step-3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,14 @@ To do so, we'll be using
[Octokit Core](https://github.com/octokit/core.js/#readme), a client that makes
it easy to interact with Github's APIs.

A [preview](https://v11-next-step-4--carbon-tutorial.netlify.app) of what you
will build (see repositories page):
A
[preview](https://carbon-tutorial-nextjs-8xoxdcixk-carbon-design-system.vercel.app/)
of what you will build (see repositories page):

<Preview
height="400"
title="Carbon Tutorial Step 3"
src="https://v11-next-step-4--carbon-tutorial.netlify.app"
src="https://carbon-tutorial-nextjs-8xoxdcixk-carbon-design-system.vercel.app/"
frameborder="no"
allowtransparency="true"
allowfullscreen="true"
Expand Down
7 changes: 4 additions & 3 deletions src/pages/developing/next-tutorial/step-4.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,14 @@ Next, we're going to use Carbon assets to build application-specific components.
We'll do so by including accessibility and responsive considerations all
throughout.

A [preview](https://v11-next-step-5--carbon-tutorial.netlify.app) of what you'll
build (see bottom of page):
A
[preview](https://carbon-tutorial-nextjs-9hg9rmepp-carbon-design-system.vercel.app/)
of what you'll build (see bottom of page):

<Preview
height="400"
title="Carbon Next Tutorial Step 4"
src="https://v11-next-step-5--carbon-tutorial.netlify.app"
src="https://carbon-tutorial-nextjs-9hg9rmepp-carbon-design-system.vercel.app/"
frameborder="no"
allowtransparency="true"
allowfullscreen="true"
Expand Down
58 changes: 7 additions & 51 deletions src/pages/developing/next-tutorial/step-5.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,10 @@ import Preview from 'components/Preview';
<PageDescription>

This step takes what we've built so far and optimizes the app for a production
environment. We'll be deploying the production build to
[Vercel](https://vercel.com/).
environment.

</PageDescription>

<InlineNotification>

**Note:** The following tutorial instructions are based on our v10 packages and
have not been updated to reflect changes for our next major version.

</InlineNotification>

<AnchorLinks>

<AnchorLink>Fork, clone and branch</AnchorLink>
Expand All @@ -58,7 +50,7 @@ A [preview](https://carbon-tutorial-nextjs.vercel.app/) of what you'll build
## Fork, clone and branch

This tutorial has an accompanying GitHub repository called
[carbon-next-tutorial](https://github.com/carbon-design-system/carbon-tutorial-nextjs)
[carbon-tutorial-nextjs](https://github.com/carbon-design-system/carbon-tutorial-nextjs)
that we'll use as a starting point for each step. If you haven't forked and
cloned that repository yet, and haven't added the upstream remote, go ahead and
do so by following the
Expand Down Expand Up @@ -100,7 +92,7 @@ yarn start
You should see something similar to where the
[previous step](/developing/next-tutorial/step-4) left off.

## Build for production
## Build for production and deploy

Before we deploy our app, we need to create an optimized production build with
this command. You may need to `CTRL-C` to stop the development environment
Expand All @@ -120,43 +112,7 @@ Create Next App, go ahead and check out their
[going to production checklist](https://nextjs.org/docs/pages/building-your-application/deploying/production-checklist)
for a full description of what's happening.

## Deploying to Vercel

Next we'll be deploying to
[Vercel](https://nextjs.org/learn/basics/deploying-nextjs-app/deploy) which
allows you to host your files directly from your repository in GitHub.

Watch or read the instructions below:

<Preview
height="400"
title="Deploying project to Vercel"
src="https://www.youtube.com/watch?v=Veg7njIKUm4"
frameborder="no"
allowtransparency="true"
allowfullscreen="true"
/>

First go to your Dashboard on Vercel and click on "Add New" then "Project".
After that you will have to find the the repository you have forked, probably
called `carbon-tutorial-nextjs` and import. Once you found the repository you
just have to click on "Deploy" and wait for the project to build.

<InlineNotification>

**Note:** Can't find the repository? Make sure Vercel has access to your Github

</InlineNotification>

Once the project was successfully deployed, we will need to select which branch
we want to use in production, by default is the `main` branch, but for this
tutorial we are going to use the `v11-next-step-5`.

On your project page, go to Settings -> Git, then look for "Production Branch"
and change the name from `main` to `v11-next-step-5`.

This change will not take effect until after the next commit to the branch, so
once the build is complete, you will need to go to the `v11-next-step-5` branch
and make a change, then push it to GitHub.

Congratulations! Your work is now hosted on Vercel
Next you can deploy your application to your preferred host, such as
[Vercel](https://nextjs.org/learn/basics/deploying-nextjs-app/deploy),
[IBM Cloud](https://www.ibm.com/cloud/free?utm_content=SRCWW&p1=Search&p4=43700074971942949&p5=e&gclid=CjwKCAjwjaWoBhAmEiwAXz8DBZSQ7ksqHmmFDCLGL-5erHPFytezo4q3fB6qJ13wkZROr3DYs95BGhoC6fUQAvD_BwE&gclsrc=aw.ds),
[Github Pages](https://docs.github.com/en/pages/quickstart).

0 comments on commit 8c60205

Please sign in to comment.