Skip to content

Commit

Permalink
docs: expanded pack related updates (#5596)
Browse files Browse the repository at this point in the history
* docs: expanded pack related updates

information about expanded pack and code builder related updates.

* Update docs/_articles/en/einstein/einstein-setup.md

Co-authored-by: mleonardsfdc <[email protected]>

* Update einstein-setup.md

fixed the setup to say only expanded pack, not extension pack.

* Update README.md

Update README for Expanded pack.

* Update einstein-setup.md

* Update README.md

* Update einstein-troubleshoot.md

update Code Builder Environment Checklist

* Update einstein-troubleshoot.md

* Update einstein-troubleshoot.md

* Update einstein-setup.md

Randi's feedback on links.

* Update docs/_articles/en/einstein/einstein-setup.md

Co-authored-by: AnanyaJha <[email protected]>

* Update einstein-setup.md

Ananya's feedback.

* Update einstein-setup.md

* Update docs/_articles/en/einstein/einstein-troubleshoot.md

Co-authored-by: Randi Wilson <[email protected]>

* Update einstein-setup.md

* Update einstein-troubleshoot.md

* Update einstein-setup.md

* Update einstein-setup.md

* Update einstein-setup.md

* Update einstein-troubleshoot.md

* Update einstein-setup.md

* Update einstein-troubleshoot.md

* Update einstein-setup.md

* Update einstein-troubleshoot.md

* Update einstein-setup.md

Update based on Randi's engineering updates.

* Update einstein-troubleshoot.md

changes in engineering workflow.

* Update einstein-setup.md

* Update einstein-troubleshoot.md

* Update einstein-setup.md

* Update einstein-troubleshoot.md

* Update einstein-setup.md

* Update einstein-troubleshoot.md

* Update einstein-troubleshoot.md

CLI telemetry instructions.

* Update einstein-setup.md

CLI telemetry

* Update docs/_articles/en/einstein/einstein-setup.md

Co-authored-by: Randi Wilson <[email protected]>

---------

Co-authored-by: mleonardsfdc <[email protected]>
Co-authored-by: Randi Wilson <[email protected]>
Co-authored-by: AnanyaJha <[email protected]>
  • Loading branch information
4 people authored May 24, 2024
1 parent 9170494 commit 5d5d330
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 10 deletions.
23 changes: 17 additions & 6 deletions docs/_articles/en/einstein/einstein-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ lang: en

## Set Up Overview

Einstein for Developers is available in the [VS Code](https://marketplace.visualstudio.com/vscode) and [Open VSX](https://open-vsx.org/) marketplaces. The extension is enabled by default in a supported Salesforce org. A developer with access to a supported org can use the extension to generate Apex code from natural language instructions, get coding suggestions using line autocomplete, or generate Apex unit tests to quickly accomplish required code coverage.
Einstein for Developers (Beta) is available in the [VS Code](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-einstein-gpt) and [Open VSX](https://open-vsx.org/extension/salesforce/salesforcedx-einstein-gpt) marketplaces as a part of the [Salesforce Expanded Pack](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode-expanded). Any developer with access to a Salesforce org can use the extension to generate Apex code from natural language instructions, get coding suggestions using line autocomplete, or generate Apex unit tests to quickly accomplish required code coverage goals.

To use Einstein for Developers on your desktop, you must have the [Salesforce Extension Pack](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode) installed in your VS Code desktop application. See [Install Salesforce Extensions](https://developer.salesforce.com/tools/vscode/en/vscode-desktop/install) for more information.

### Required Editions

Expand All @@ -27,10 +26,10 @@ VS Code releases a new version each month with new features and important bug fi

### Interaction with other AI-enabled Extensions

- You may run into some unexpected generated code outcomes if you have multiple AI-enabled extensions installed in VS Code. We recommend you disable all other AI-enabled extensions when working with Einstein for Developers:
1. Click the Extensions icon in the Activity Bar, search for the extension to disable by name.
2. Click **Disable** in the extension's marketplace page.
3. Repeat for all installed AI-enabled extensions.
You may run into some unexpected generated code outcomes if you have multiple AI-enabled extensions installed in VS Code. We recommend you disable all other AI-enabled extensions when working with Einstein for Developers:
1. Click the Extensions icon in the Activity Bar, search for the extension to disable by name.
2. Click **Disable** in the extension's marketplace page.
3. Repeat for all installed AI-enabled extensions.


## Enable or Disable Einstein For Developers in VS Code
Expand All @@ -44,6 +43,18 @@ The Einstein for Developers status icon in the bottom panel of the Visual Studio

You can disable or uninstall the Einstein for Developers extension at any time. Bring up the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of VS Code or the **View: Show Extensions** command (⇧⌘X). Search for "Einstein for Developers" in installed extensions list, and then select **Disable** or **Uninstall**.

### Use Einstein for Developers in Code Builder

Einstein for Developers is disabled by default in new Code Builder environments. Telemetry is used to audit enablement of Salesforce Generative AI functionality and must be on when you enable the extension:

1. Go to **Settings** and search for `salesforcedx-vscode-core.telemetry.enabled` to confirm that this Salesforce telemetry setting is on in your workspace.
2. If the setting isn't on, select the checkbox to enable telemetry.
3. Open a terminal and run `sf config set disable-telemetry=false --global` to enable CLI telemetry. See [Salesforce CLI Data Collection and Metrics](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_telemetry.htm) for more information.
4. Run **Developer: Reload Window**.
5. Click the Einstein icon in the status bar and enable the extension.

Salesforce telemetry is on by default and can be turned off once the extension is enabled.

### Use Einstein for Developers in a Scratch Org

Einstein for Developers is only available in scratch org editions that can author Apex:
Expand Down
10 changes: 7 additions & 3 deletions docs/_articles/en/einstein/einstein-troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,16 @@ Use this troubleshooting checklist to identify and eliminate common problems wit
2. Check that your Einstein for Developers extension is activated using the **Developer: Show Running Extensions** command. If your extension isn’t activating, file an [issue](https://github.com/forcedotcom/Einstein-GPT-for-Developers/issues) in our GitHub repo.
3. Make sure you’re connected to a Salesforce org. The status of your default org connection is visible in the status bar.


![Default Org](./images/default-org.png)


**Tip**: Run the **SFDX: Open Default Org** command to easily check that your Salesforce extensions are running correctly and that you're connected to a Salesforce org.

### Code Builder Environment Checklist

Einstein for Developers is disabled by default in new Code Builder environments. Telemetry is used to audit enablement of Salesforce Generative AI functionality and must be on when you enable the extension:


1. Go to **Settings** and search for `salesforcedx-vscode-core.telemetry.enabled` to confirm that this Salesforce telemetry setting is on in your workspace.
2. If the setting isn't on, select the checkbox to enable telemetry.
3. Open a terminal and run `sf config set disable-telemetry=false --global` to enable CLI telemetry. See [Salesforce CLI Data Collection and Metrics](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_telemetry.htm) for more information.
4. Run **Developer: Reload Window**.
5. Click the Einstein icon in the status bar and enable the extension.
3 changes: 2 additions & 1 deletion packages/salesforcedx-vscode-expanded/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Before you set up Salesforce Extensions for VS Code, make sure that you have the

If you also use other versions of the JDK, set your VS Code user setting `salesforcedx-vscode-apex.java.home` to point to the location where you installed Java 11 or 17.

- **[Visual Studio Code](https://code.visualstudio.com/download) v1.61.2 or later**
- **[Visual Studio Code](https://code.visualstudio.com/download) v1.82.0 or later**

## Documentation

Expand Down Expand Up @@ -55,6 +55,7 @@ The Salesforce Extension Pack extension installs these extensions.
This extension (`salesforcedx-vscode-visualforce`) supports Visualforce pages and components. It uses the Visualforce Language Server and the HTML language server from VS Code.
- [Salesforce Lightning Design System (SLDS) Validator](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforce-vscode-slds)
This extension (`salesforcedx-vscode-slds`) simplifies working with the Salesforce Lightning Design System (SLDS). It provides code completion, syntax highlighting and validation with recommended tokens and utility classes.
- [Einstein for Developers (Beta)](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-einstein-gpt) This extension (`salesforcedx-einstein-gpt`) uses generative AI to make Salesforce development in Visual Studio Code richer with features such as natural language to code generation, inline autocompletion for Apex and LWC code, and test case generation for Apex classes.

It also includes the following community built extensions.

Expand Down

0 comments on commit 5d5d330

Please sign in to comment.