Skip to content

Commit

Permalink
update the docs with vc-build package management features
Browse files Browse the repository at this point in the history
  • Loading branch information
tatarincev committed May 17, 2021
1 parent f920400 commit 0359c5e
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 18 deletions.
16 changes: 10 additions & 6 deletions docs/fundamentals/essential-modularity.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ This fact may lead to an unexpected update of third-party dependencies for other

Virto has two different install and update modes for modules: **Runtime** and **Design-time** respectively.

**Runtime** - this mode is used for update and install modules on working system or in first time setup and this process based on request to special resource file modules.json that can be on public or internal access and it contains information about all modules and their latest major versions (minor and patch versions history not stored). Path to this file can be set by a special setting in the platform `appsettings.json` file.
**Runtime** - this mode is used for update and install modules on working system or in first time setup and this process based on request to special resource file modules.json (registry_ that can be on public or internal access and it contains information about all modules and their latest major versions (minor and patch versions history not stored). Path to this file can be set by a special setting in the platform `appsettings.json` file.

*`module.manifest`*
```JSON
Expand All @@ -174,13 +174,17 @@ How this process works for the virto platform modules for both platform major ve
![image|624x170](../media/essential-modularity-5.png)


**Design time** – this mode is often used during development, when you manage installed versions of modules, install them manually or update them in the `~/Modules` discovery folder on the local computer or in any other public environment. The main disadvantage of this method is it not distributed to other team members because of versions and list of used modules doesn’t preserved in version controls system and can’t be shared.
Also we can setup module with vc-build tool:
**Design time with using CLI** – this mode is often used during development, when you manage installed versions of modules, install or update them manually on the local computer or in any other public environment. The virto provides the special CLI tool for this, check out [vc-build for packages management](https://github.com/VirtoCommerce/vc-platform/tree/dev/build#packages-management) for more info.

Examples:

```console
vc-build Install -Module VirtoCommerce.Store
```
//Install the latest version of a particular module
vc-build install -Module VirtoCommerce.Store

>The virto platform team is currently working on improving of this process, where you can work with all modules in one solution (mono-repositoriy) and manage versions and dependencies of all modules in the same way as you can manage NuGet dependencies for regular solutions containing several projects.
//Update platform and all installed modules to the latest version
vc-build update
```

## Module deployment process

Expand Down
21 changes: 15 additions & 6 deletions docs/getting-started/deploy-from-precompiled-binaries-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ Use this guide to <a class="crosslink" href="https://virtocommerce.com/ecommerce
* [.NET Core SDK on Linux](https://dotnet.microsoft.com/download/linux-package-manager/ubuntu19-04/sdk-current)
* [Microsoft SQL Server](https://www.microsoft.com/en-us/sql-server/sql-server-2017-editions)



## You have two options for installing the platform

* Manual downloading the precomplied binaries
* Using CLI (beta)


## Downloading the precomplied binaries

* Navigate to the <a href="https://github.com/VirtoCommerce/vc-platform/releases">Releases section of Virto Commerce Platform in GitHub.</a>
Expand All @@ -23,21 +31,22 @@ wget "https://github.com/VirtoCommerce/vc-platform/releases/download/3.x.x/Virto
unzip VirtoCommerce.Platform.3.x.x.zip -d vc-platform-3
```

## Downloading with vc-build tool
## Using `vc-build` CLI (beta).

* Install vc-build
```console
dotnet tool install -g VirtoCommerce.GlobalTool
```
* Install platform
* Install platform and modules
```console
vc-build Init
vc-build InstallPlatform
vc-build install
```
Also you can specify the platform version:
```console
vc-build Init -PlatformVersion 3.52.0
vc-build InstallPlatform
vc-build install -version 3.55.0
```
Check out [vc-build for packages management](https://github.com/VirtoCommerce/vc-platform/tree/dev/build#packages-management) for more info.


## Setup

Expand Down
19 changes: 13 additions & 6 deletions docs/getting-started/deploy-from-precompiled-binaries-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ Use this guide to <a class="crosslink" href="https://virtocommerce.com/ecommerce
* [.NET Core 3.1 SDK](https://dotnet.microsoft.com/download/dotnet/3.1)
* [Microsoft SQL Server](https://www.microsoft.com/en-us/sql-server/sql-server-downloads)


## You have two options for installing the platform

* Manual downloading the precomplied binaries
* Using CLI (beta)

## Downloading the precomplied binaries

* Navigate to the <a href="https://github.com/VirtoCommerce/vc-platform/releases">Releases section of Virto Commerce Platform in GitHub.</a>
Expand All @@ -15,21 +21,22 @@ Use this guide to <a class="crosslink" href="https://virtocommerce.com/ecommerce

* Unpack this zip to a local directory **C:\vc-platform-3**. After that you will have the directory with Platform precompiled files.

## Downloading with vc-build tool

## Using `vc-build` CLI (beta).

* Install vc-build
```console
dotnet tool install -g VirtoCommerce.GlobalTool
```
* Install platform
* Install platform and modules
```console
vc-build Init
vc-build InstallPlatform
vc-build install
```
Also you can specify the platform version:
```console
vc-build Init -PlatformVersion 3.52.0
vc-build InstallPlatform
vc-build install -version 3.55.0
```
Check out [vc-build for packages management](https://github.com/VirtoCommerce/vc-platform/tree/dev/build#packages-management) for more info.

## Setup

Expand Down

0 comments on commit 0359c5e

Please sign in to comment.