Skip to content

Commit

Permalink
chore(website): Update LWC Framework page (carbon-design-system#3804)
Browse files Browse the repository at this point in the history
* Chore: Update LWC Framework doc

* Update lwc.mdx

Update Storybook endpoint
  • Loading branch information
ccwilson-us-ibm-com authored Nov 17, 2023
1 parent d159409 commit 823335b
Showing 1 changed file with 7 additions and 25 deletions.
32 changes: 7 additions & 25 deletions src/pages/developing/frameworks/lwc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ platform.

The LWC components are maintained by the
[Carbon for Salesforce team](https://github.ibm.com/carbon-for-salesforce/carbon-for-salesforce).
V11 upgrade is currently underway. Please reach out for support and
contribution.

</InlineNotification>

Expand All @@ -42,7 +40,7 @@ contribution.
<Column colLg={4} colMd={4} noGutterSm>
<ResourceCard
subTitle="Carbon for Salesforce Storybook"
href="https://carbon-for-salesforce.nnuka7gjzia.us-east.codeengine.appdomain.cloud/"
href="https://carbon-for-salesforce.17f48735.public.multi-containers.ibm.com"
>

![Storybook icon](images/storybook.svg)
Expand Down Expand Up @@ -72,20 +70,18 @@ Carbon for IBM.com, and Carbon for IBM Products, along with custom components
bespoke to Salesforce platform products.

Within IBM, C4S is used by the Cognitive Support Platform project with
`ibm.com/support` being the client facing experience of IBM Support. We're also
just kicking off the use of C4S on IBM Partner Portal.
`ibm.com/support` being the client facing experience of IBM Support.

### List of available components

We are starting to develop components based on Carbon v11 in 2022 Q2. The source
code and setup instructions can be found on the
The source code and setup instructions can be found on the
[GitHub respository](https://github.ibm.com/carbon-for-salesforce/carbon-for-salesforce).

See list of available components in
[Storybook](https://pages.github.ibm.com/carbon-for-salesforce/carbon-for-salesforce/).
[Storybook](https://carbon-for-salesforce.17f48735.public.multi-containers.ibm.com).

Additional documentation is available in
[ISC Playbook](https://isc-playbook.mybluemix.net/#/documents/b92d2ed082c108d76ee91887234558c9).
[ISC Playbook](https://isc-playbook.us1a.cirrus.ibm.com/#/documents/b92d2ed082c108d76ee91887234558c9).

## Getting started

Expand Down Expand Up @@ -140,24 +136,18 @@ Then navigate to the project folder
cd carbon-for-salesforce
```

Install dependencies with either `npm` or `yarn`.
Install dependencies with `npm`.

Please note, recommended Node.js version is `v16`. To switch between node
Please note, recommended Node.js version is `v20`. To switch between node
versions we recommend <a href="https://github.com/nvm-sh/nvm">NVM (Node Version
Manager)</a>.

```
npm install
or
yarn
```

### 6. Working with Storybook

All commands below works if `npm run` is replaced with `yarn`.

Start storybook

```
Expand All @@ -180,20 +170,12 @@ Run unit tests

```
npm test
or
yarn test
```

### 7. Start local lwc development server

```
npm start
or
yarn start
```

## Troubleshooting
Expand Down

0 comments on commit 823335b

Please sign in to comment.