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.

Sign up for GitHub

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

chore(website): Update LWC Framework page #3804

Merged
merged 5 commits into from
Nov 17, 2023
Merged

chore(website): Update LWC Framework page #3804

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fdf0cfa
Chore: Update LWC Framework doc
ccwilson-us-ibm-com Nov 6, 2023
b0a84dd
Update lwc.mdx
ccwilson-us-ibm-com Nov 13, 2023
8945a05
Merge branch 'main' into chore-lwc-update
ccwilson-us-ibm-com Nov 13, 2023
7057b4a
Merge branch 'main' into chore-lwc-update
ccwilson-us-ibm-com Nov 16, 2023
c838598
Merge branch 'main' into chore-lwc-update
ccwilson-us-ibm-com Nov 17, 2023
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
32 changes: 7 additions & 25 deletions src/pages/developing/frameworks/lwc.mdx
View file
Open in desktop
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
Loading