Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(tutorial): add initial faqs #3088

Merged
merged 6 commits into from
Aug 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions src/pages/developing/react-tutorial/faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: FAQs
description:
Welcome to Carbon! This tutorial will guide you in creating a React app with
the Carbon Design System.
tabs:
[
'Overview',
'Step 1',
'Step 2',
'Step 3',
'Step 4',
'Step 5',
'Wrapping up',
'FAQ',
]
---

### 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
from the one used in the tutorial step. To fix this, you can go to the Github
branch for the step you are on, find the `yarn.lock` file, and copy that file
into your working directory. You may need to delete your `node_modules` folder
and run `yarn` afterwards.

### I am getting a <span className='tutorial-faq-header-code'>`yarn offline cache`</span> error. How do I fix this?

- Try running
`rm -rf .yarn-offline-mirror node_modules && yarn cache clean && yarn install`
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.

### When will I get the badge?

- After you've completed the tutorial, as well as the form and badge survey
mentioned
[here](https://carbondesignsystem.com/developing/react-tutorial/wrapping-up#badge-process),
our badge issuer will approve your badge. This is a manual job done by one
person. Please be patient if it takes a while to review as we have lots of
people go thru our tutorial badging process.

- Badge issuer contact: [email protected].

- For questions related to your Acclaim badge earner account and profile, as
well as issues related to claiming your badge after receiving a notification,
go to http://support.youracclaim.com for account issues.

### Other troubleshooting tips

- We updated the `react-scripts` dependency to `v5.0.1`. Pull from `upstream`
and run `yarn` or `npm install` to update your remote branch.
- You no longer need the `.env` with the updated `react-scripts` dependency. If
you are up to date, you can delete that file (previously at the root level).
- Run `yarn format` and commit any changes made.
11 changes: 10 additions & 1 deletion src/pages/developing/react-tutorial/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@ description:
Welcome to Carbon! This tutorial will guide you in creating a React app with
the Carbon Design System.
tabs:
['Overview', 'Step 1', 'Step 2', 'Step 3', 'Step 4', 'Step 5', 'Wrapping up']
[
'Overview',
'Step 1',
'Step 2',
'Step 3',
'Step 4',
'Step 5',
'Wrapping up',
'FAQ',
]
---

import Preview from 'components/Preview';
Expand Down
11 changes: 10 additions & 1 deletion src/pages/developing/react-tutorial/step-1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@ description:
Welcome to Carbon! This tutorial will guide you in creating a React app with
the Carbon Design System.
tabs:
['Overview', 'Step 1', 'Step 2', 'Step 3', 'Step 4', 'Step 5', 'Wrapping up']
[
'Overview',
'Step 1',
'Step 2',
'Step 3',
'Step 4',
'Step 5',
'Wrapping up',
'FAQ',
]
---

import Preview from 'components/Preview';
Expand Down
11 changes: 10 additions & 1 deletion src/pages/developing/react-tutorial/step-2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@ description:
Welcome to Carbon! This tutorial will guide you in creating a React app with
the Carbon Design System.
tabs:
['Overview', 'Step 1', 'Step 2', 'Step 3', 'Step 4', 'Step 5', 'Wrapping up']
[
'Overview',
'Step 1',
'Step 2',
'Step 3',
'Step 4',
'Step 5',
'Wrapping up',
'FAQ',
]
---

import Preview from 'components/Preview';
Expand Down
11 changes: 10 additions & 1 deletion src/pages/developing/react-tutorial/step-3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@ description:
Welcome to Carbon! This tutorial will guide you in creating a React app with
the Carbon Design System.
tabs:
['Overview', 'Step 1', 'Step 2', 'Step 3', 'Step 4', 'Step 5', 'Wrapping up']
[
'Overview',
'Step 1',
'Step 2',
'Step 3',
'Step 4',
'Step 5',
'Wrapping up',
'FAQ',
]
---

import Preview from 'components/Preview';
Expand Down
11 changes: 10 additions & 1 deletion src/pages/developing/react-tutorial/step-4.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@ description:
Welcome to Carbon! This tutorial will guide you in creating a React app with
the Carbon Design System.
tabs:
['Overview', 'Step 1', 'Step 2', 'Step 3', 'Step 4', 'Step 5', 'Wrapping up']
[
'Overview',
'Step 1',
'Step 2',
'Step 3',
'Step 4',
'Step 5',
'Wrapping up',
'FAQ',
]
---

import Preview from 'components/Preview';
Expand Down
11 changes: 10 additions & 1 deletion src/pages/developing/react-tutorial/step-5.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@ description:
Welcome to Carbon! This tutorial will guide you in creating a React app with
the Carbon Design System.
tabs:
['Overview', 'Step 1', 'Step 2', 'Step 3', 'Step 4', 'Step 5', 'Wrapping up']
[
'Overview',
'Step 1',
'Step 2',
'Step 3',
'Step 4',
'Step 5',
'Wrapping up',
'FAQ',
]
---

import Preview from 'components/Preview';
Expand Down
11 changes: 10 additions & 1 deletion src/pages/developing/react-tutorial/wrapping-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@ description:
Welcome to Carbon! This tutorial will guide you in creating a React app with
the Carbon Design System.
tabs:
['Overview', 'Step 1', 'Step 2', 'Step 3', 'Step 4', 'Step 5', 'Wrapping up']
[
'Overview',
'Step 1',
'Step 2',
'Step 3',
'Step 4',
'Step 5',
'Wrapping up',
'FAQ',
]
---

<PageDescription>
Expand Down
7 changes: 7 additions & 0 deletions src/styles/_page.scss
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,10 @@ section[role='tabpanel'] [class*='--col'] + [class*='--col'] {
.tab--columns_label {
margin-bottom: 0.5rem;
}

.tutorial-faq-header-code code {
background-color: $ui-03;
font-size: 1.25rem;
padding: 0 0.5rem;
border-radius: 0.25rem;
}