Skip to content

Commit

Permalink
SELFDEV-576 + DEVDOCS-5863: [organize] Make docs structure match IA, …
Browse files Browse the repository at this point in the history
…move newer public docs to public repo (#324)

<!-- Ticket number or summary of work -->
# [SELFDEV-576] + [DEVDOCS-5863]

## What changed?
<!-- Provide a bulleted list in the present tense -->
* Make docs structure match IA
* BOPIS and promotions docs into public repo
* Other than adding the spec files from bopis and promotions to the dev
center, i did not reorganize the API reference because that requires
comms and advance notice to everyone who maintains an API client or SDK.

## Release notes draft
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->
* The bigcommerce/docs repo now contains the OAS for promotions,
inventory, locations, and other newer API features!
* It's now easier than ever to contribute to the docs. The source file
structure in the repo now matches the Dev Center URLs. Finding the doc
you want to modify never had less friction :)
* This only applies to the narrative docs. API reference source file
restructure is in the works as soon as we can give enough notice for all
you API client maintainers to reset your references.

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->

ping @bc-tgomez @bc-traciporter


[SELFDEV-576]:
https://bigcommercecloud.atlassian.net/browse/SELFDEV-576?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[DEVDOCS-5863]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-5863?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
Sarah Riehl authored Jun 12, 2024
1 parent 115e238 commit 66dbab0
Show file tree
Hide file tree
Showing 602 changed files with 45,983 additions and 19,630 deletions.
Original file line number Diff line number Diff line change
@@ -1,67 +1,67 @@
# Installing Legacy Theme Modules



If a theme’s version number is lower than `1.10.0`, the theme uses `jspm` as its JavaScript build system. Follow the steps outlined on this article to install theme modules via `jspm`.



## Step 1: Install `jspm`

```shell copy
npm install -g [email protected]
```

Or, for Windows:

```shell copy
npm install -g [email protected]
```

## Step 2: Register `jspm` Instance

Next, register your jspm instance with GitHub. To do so:
* Navigate to your [GitHub Personal Access Tokens page](https://github.com/settings/tokens).
* Generate a new personal access token with the name `Stencil` and scope `repo` (GitHub provides specific instructions).
* Verify the token includes the following scopes: `repo:status`, `repo_deployment`, and `public_repo`.
* Run the following command in a terminal to associate the `jspm` module and GitHub account: `jspm registry config github`
* When prompted with `Set up GitHub credentials?`, copy and paste the access token created above.

## Step 3: Install `jspm-git`

For the next step, you will need the [jspm-git registry plug-in](https://www.npmjs.com/package/jspm-git).

To install it, enter the following in a terminal:

```shell copy showLineNumbers
# Install jspm-git registry plug-in
npm install -g jspm-git
```

If you already have an earlier version of `jspm-git` installed, you might need to update it to handle git projects with two-digit version numbers:

```shell copy showLineNumbers
npm upgrade jspm-git@latest
```

## Step 4: Add BitBucket as a `jspm` Registry

Working with downloaded Marketplace themes requires adding a BitBucket registry for `jspm`. To do so, you'll need a [BitBucket account](https://bitbucket.org/product). Once you have an account, enter the following in a terminal to add BitBucket as a `jspm` registry:

```shell copy showLineNumbers
jspm registry create bitbucket jspm-git

# When prompted for a base URL, Enter: ssh://[email protected]
```

## Step 5: Install the Modules

Finally, install the `npm` and `jspm` modules required to access Stencil JavaScript events:

```shell copy showLineNumbers
# move into the theme's directory
cd ~/path/to/theme

# install the modules with jspm
jspm install
```
# Installing Legacy Theme Modules



If a theme’s version number is lower than `1.10.0`, the theme uses `jspm` as its JavaScript build system. Follow the steps outlined on this article to install theme modules via `jspm`.



## Step 1: Install `jspm`

```shell copy
npm install -g [email protected]
```

Or, for Windows:

```shell copy
npm install -g [email protected]
```

## Step 2: Register `jspm` Instance

Next, register your jspm instance with GitHub. To do so:
* Navigate to your [GitHub Personal Access Tokens page](https://github.com/settings/tokens).
* Generate a new personal access token with the name `Stencil` and scope `repo` (GitHub provides specific instructions).
* Verify the token includes the following scopes: `repo:status`, `repo_deployment`, and `public_repo`.
* Run the following command in a terminal to associate the `jspm` module and GitHub account: `jspm registry config github`
* When prompted with `Set up GitHub credentials?`, copy and paste the access token created above.

## Step 3: Install `jspm-git`

For the next step, you will need the [jspm-git registry plug-in](https://www.npmjs.com/package/jspm-git).

To install it, enter the following in a terminal:

```shell copy showLineNumbers
# Install jspm-git registry plug-in
npm install -g jspm-git
```

If you already have an earlier version of `jspm-git` installed, you might need to update it to handle git projects with two-digit version numbers:

```shell copy showLineNumbers
npm upgrade jspm-git@latest
```

## Step 4: Add BitBucket as a `jspm` Registry

Working with downloaded Marketplace themes requires adding a BitBucket registry for `jspm`. To do so, you'll need a [BitBucket account](https://bitbucket.org/product). Once you have an account, enter the following in a terminal to add BitBucket as a `jspm` registry:

```shell copy showLineNumbers
jspm registry create bitbucket jspm-git

# When prompted for a base URL, Enter: ssh://[email protected]
```

## Step 5: Install the Modules

Finally, install the `npm` and `jspm` modules required to access Stencil JavaScript events:

```shell copy showLineNumbers
# move into the theme's directory
cd ~/path/to/theme

# install the modules with jspm
jspm install
```
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Example JSON returned in the response:

## Update a Product Review

Updates an existing product review. Your request may update any of the properties that are writeable for the Create (POST) operation.
Updates an existing product review. Your request may update any of the properties that are writable for the Create (POST) operation.

`PUT /stores/{store_hash}/v2/products/{product_id}/reviews/{id}`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Creating Products and Variants on V3:

Variants can be included with a GET request to lower the number of API calls being made using `?include=variants`.

V3 includes endpoints for working with catalog trees. Stores that have multi-storefront enabled can have more than one tree. See the catagories section of the [Multi-Storefront API Guide](/docs/storefront/multi-storefront/guide#categories). Stores that are not MSF-enabled can use the same endponts.
V3 includes endpoints for working with catalog trees. Stores that have multi-storefront enabled can have more than one tree. See the categories section of the [Multi-Storefront API Guide](/docs/storefront/multi-storefront/guide#categories). Stores that are not MSF-enabled can use the same endponts.

## Interoperability between V2 and V3

Expand Down
Loading

0 comments on commit 66dbab0

Please sign in to comment.