DEVDOCS-6497 - Buyer Portal guides #1096
Conversation
Base information added to each file. Guides for Headless and Stencil filled in. Missing screenshots. Other files are placeholders for future content.
bc-terra
added
do not merge
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| Any Stencil storefront with B2B Edition enabled will include the hosted version of the B2B Buyer Portal by default. | ||
|
|
||
| When B2B Edition is activated for the storefront, B2BEdition Header Script and B2BEdition Footer Script will automatically be configured in the channel’s Script Manager. |
There was a problem hiding this comment.
B2BEdition is misspelt retext-spell retext-spell
|
|
||
| Any Stencil storefront with B2B Edition enabled will include the hosted version of the B2B Buyer Portal by default. | ||
|
|
||
| When B2B Edition is activated for the storefront, B2BEdition Header Script and B2BEdition Footer Script will automatically be configured in the channel’s Script Manager. |
There was a problem hiding this comment.
B2BEdition is misspelt retext-spell retext-spell
|
|
||
| Scripts configured within Script Manager for a storefront channel are automatically injected into the Stencil theme for that storefront. In the case of the B2B Buyer Portal, these scripts are injected into all pages of the storefront to initialize the React application. | ||
|
|
||
| This means that, in Stencil, this entry point is the traffic controller that determines whether the storefront loads the hosted Buyer Portal experience or your own customized Buyer Portal. |
There was a problem hiding this comment.
Hard to read sentence (confidence: 4/7) retext-readability retext-readability
|
|
||
| This means that, in Stencil, this entry point is the traffic controller that determines whether the storefront loads the hosted Buyer Portal experience or your own customized Buyer Portal. | ||
|
|
||
| With the default scripts in place loading the hosted Buyer Portal, your storefront will automatically receive updates when new versions of the Buyer Portal are released. However, if you have customized the Buyer Portal as described below, it is up to you to pull in upstream changes from the Buyer Portal repository and integrate them with your own customizations. |
There was a problem hiding this comment.
Hard to read sentence (confidence: 4/7) retext-readability retext-readability
| After your local Buyer Portal instance is running, you must now update your Stencil storefront to inject this version of the Buyer Portal instead of the default hosted version. | ||
|
|
||
| 1. Navigate to Script Manager in the BigCommerce control panel. (In a multi-storefront configuration, you’ll find this in the settings for the individual storefront channel.) | ||
| 2. Delete the default “B2BEdition Header Script” and “B2BEdition Footer Script.” |
There was a problem hiding this comment.
B2BEdition is misspelt retext-spell retext-spell
| ></script> | ||
| ``` | ||
|
|
||
| With this technique in place, subsequent builds of your custom Buyer Portal won’t require you to change your storefront code, only update your variable in the appropriate environment and redeploy. |
There was a problem hiding this comment.
Hard to read sentence (confidence: 4/7) retext-readability retext-readability
|
|
||
| `B2B_LOCAL_LOADER=TRUE` | ||
|
|
||
| The following example Next.js code can toggle the appropriate loader scripts based on whether you’re running a local Buyer Portal project or loading a deployed Buyer Portal. |
There was a problem hiding this comment.
Hard to read sentence (confidence: 4/7) retext-readability retext-readability
|
|
||
| ## Co-Locating the Buyer Portal with Your Storefront Code | ||
|
|
||
| While your headless storefront and the Buyer Portal are, by nature, separate applications with their own codebases, you may find it desirable to locate their source code together in the same repository. |
There was a problem hiding this comment.
Hard to read sentence (confidence: 4/7) retext-readability retext-readability
|
|
||
| ## Co-Locating the Buyer Portal with Your Storefront Code | ||
|
|
||
| While your headless storefront and the Buyer Portal are, by nature, separate applications with their own codebases, you may find it desirable to locate their source code together in the same repository. |
There was a problem hiding this comment.
codebases is misspelt; did you mean codebase? retext-spell retext-spell
| * Building and deploying | ||
| * Script config | ||
|
|
||
| ### Theming Without a Custom Buyer Portal No newline at end of file |
There was a problem hiding this comment.
Theming is misspelt; did you mean Teeming? retext-spell retext-spell
Initial branch creation with relevant guide files.
Base information added to each file.
Guides for Headless and Stencil filled in. Missing screenshots. Other files are placeholders for future content.
DEVDOCS-6497
What changed?
Release notes draft
Anything else?
ping { @CNanninga @bigcommerce/dev-docs-team }