Skip to content

Commit

Permalink
feat: update deps
Browse files Browse the repository at this point in the history
  • Loading branch information
bojanrajh committed Dec 7, 2023
1 parent d8ed465 commit 256c5f8
Show file tree
Hide file tree
Showing 3 changed files with 97 additions and 90 deletions.
41 changes: 24 additions & 17 deletions QUICK-START.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,42 @@ In this introduction, you will learn how to:
- [Preview your changes](#4-preview-your-changes)
- [Commit, merge and deploy your changes](#5-commit-merge-and-deploy-your-changes)

## TL;DR>

Try running the following commands in any repo that is embedded in DevHub:

```
$ pnpm docs:env
$ pnpm docs:link
$ pnpm docs:preview
```

## 0. Prerequisites

- Node v18
- Node v18

_Note: These commands has been added to feature branches in all repositories and may not have been merged yet.
It is advisable to check out the correct branch before proceeding. Alternatively, you can directly call the CLI by using
the command `../developer-portal/docs-cli.cjs manage`._

## 1. Checkout the developer-portal repository

The `developer-portal` repository allows you to set up a local environment for
the [docs](https://developer.shopware.com).
To get started, follow these steps:

- clone the repository to your local machine,
- install all necessary dependencies,
- and build the CLI.
the [DevHub](https://developer.shopware.com). Embedded repositories have a `docs:env` npm script available for setting
up the environment in your local `../developer-portal` repository - it serves as a shortcut for cloning or pulling the
`developer-portal` repository to your local machine and installing npm dependencies.

```bash
# from an embedded repository
$ pnpm docs:env
# or manually
$ cd /www/
$ git clone ssh://[email protected]/shopware/developer-portal.git
$ cd developer-portal
$ pnpm i

```

Validate CLI:
Check the CLI:

```bash
# from the /www/developer-portal/ dir
Expand All @@ -49,7 +62,6 @@ Typically, you will already have your repository checked out on your computer. F
$ cd /www/
$ git clone ssh://[email protected]/shopware/frontends.git
$ cd frontends

```

## 3. Link your local docs into the developer-portal
Expand All @@ -68,11 +80,6 @@ $ pnpm docs:link

```

_Note: The `docs:link` command has been added to feature branches in all repositories and may not have been merged yet.
It is advisable to check out the correct branch before proceeding. Alternatively, you can directly call the CLI by using
the command `../developer-portal/docs-cli link` and pass the `src` and `dst` options such as
`--src apps/docs/src --dst frontends`._

## 4. Preview your changes

With the previous steps completed, you are now ready to run the preview. By using this command, it will launch the Vite
Expand Down Expand Up @@ -153,12 +160,12 @@ $ pnpm docs:manage

**Pull the latest version**

This command is just an alias for pulling changes from remote, installing NPM dependencies and rebuilding the CLI.
This command is just an alias for pulling changes from remote and installing NPM dependencies.

```bash
$ ./docs-cli.cjs pull
# or
$ pnpm docs:pull
$ pnpm docs:env

```

Expand Down
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"cross-env": "^7.0.3",
"terser": "^5.25.0",
"vitepress": "1.0.0-rc.25",
"vitepress-shopware-docs": "1.1.0-alpha.5",
"vitepress-shopware-docs": "1.1.0-alpha.6",
"vue": "^3.3.10"
},
"devDependencies": {
Expand All @@ -40,10 +40,10 @@
"@originjs/vite-plugin-require-context": "^1.0.9",
"@playwright/test": "1.39.0",
"@shopware-docs/cli": "1.1.0-alpha.5",
"@shopware-docs/storybook": "1.1.0-alpha.5",
"@shopware-docs/typer": "1.1.0-alpha.5",
"@shopware-docs/vitepress": "1.1.0-alpha.5",
"@shopware-docs/vitest": "1.1.0-alpha.5",
"@shopware-docs/storybook": "1.1.0-alpha.6",
"@shopware-docs/typer": "1.1.0-alpha.6",
"@shopware-docs/vitepress": "1.1.0-alpha.6",
"@shopware-docs/vitest": "1.1.0-alpha.6",
"@storybook/addon-essentials": "^7.6.3",
"@storybook/addon-interactions": "^7.6.3",
"@storybook/addon-links": "^7.6.3",
Expand Down
Loading

0 comments on commit 256c5f8

Please sign in to comment.