Skip to content

Commit 51bfa0b

Browse files
committed
initial draft for install
1 parent 6333ae7 commit 51bfa0b

File tree

3 files changed

+65
-15
lines changed

3 files changed

+65
-15
lines changed

docs/develop/marketplace-packages/development/index.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Marketplace Packages: Development and Publication"
33
icon: material/code-json
44
tags:
5-
- Python
5+
- Package
66
---
77
# Development and Publication of Marketplace Packages
88

@@ -35,16 +35,16 @@ You can remove a license entirely; however, a package that does not declare a li
3535

3636
The `manifest.json` is the central package definition.
3737
It contains all relevant package metadata and describes the package contents.
38-
It is used to present package details and contents to the `inspect` commands<!-- or in the marketplace frontends-->, to install, configure and uninstall all parts of a package.
38+
It is used to present package details and contents to the `inspect` command<!-- or in the marketplace frontends-->, to install, configure and uninstall all parts of a package.
3939

4040
#### Metadata
4141

4242
`package_type`
4343
: `project`
44-
: A package that may ship any content, mainly intended to contain BUILD projects, (instance/data) graphs, SHACL shapes, workspace configuration, query catalogs, etc.
44+
: A package that may ship any content, mainly intended to contain Build projects, (instance/data) graphs, SHACL shapes, workspace configuration, query catalogs, etc.
4545

4646
`vocabulary`
47-
: A package that is supposed to contribute vocabulary / ontology contents, such as `rdf:`, `org:`, `sso:`, etc. Such package may contain multiple vocabularies / ontologies. Packaging related SHACL shapes is reasonable, too.
47+
: A package that is supposed to contribute vocabulary / ontology contents, such as `rdf:`, `org:`, `sso:`, etc. Such a package may contain multiple vocabularies / ontologies. Packaging related SHACL shapes is reasonable, too.
4848

4949
`package_id`
5050
: Unique package identifier
@@ -153,7 +153,7 @@ The following pages give an overview about this feature:
153153

154154
![Corporate Memory Marketplace Package Lifecycle](../mpp-lifecycle.svg){ width="50%" }
155155

156-
### Installing (local) Packages
156+
### Install (local) Packages
157157

158158
Use the following command to install a local package folder content (or built `.cpa` file) to a Corporate Memory (package development) instance.
159159

@@ -164,17 +164,25 @@ cmemc package install --input PATH
164164
Make changes to graphs, configuration, or Build projects as needed.
165165
Newly created or imported graphs or Build projects need to be registered in `manifest.json` so they will be fetched by `export`.
166166

167-
### Exporting Contents into a Package
167+
### Export Contents into a Package
168168

169169
Use the following command to export the file artifacts declared in `manifest.json` from a Corporate Memory (package development) instance to a local package folder.
170170

171171
```sh
172172
cmemc package export PACKAGE_ID
173173
```
174174

175-
Run this to initially populate package contents from a solution configuration or to update them after making changes on your Corporate Memory (package development) instance, in order to capture and eventually build/release them as a Marketplace Package.
175+
Run this to initially populate package contents from a solution configuration. You can also use it to update contents after making changes on your Corporate Memory (package development) instance, capturing them for building and releasing as a Marketplace Package.
176176

177-
### Building Packages
177+
### Inspect Packages
178+
179+
Review and verify the contents of a package with the following command:
180+
181+
```sh
182+
cmemc package inspect PACKAGE_PATH
183+
```
184+
185+
### Build Packages
178186

179187
During development you can install a package from a local path (plain folder or a `.cpa` package) using the `cmemc package install --input PATH` command.
180188

@@ -183,6 +191,7 @@ This will build a package archive from a package directory.
183191

184192
This command processes a package directory, validates its content including the manifest, and creates a versioned Corporate Memory package archive (`.cpa`) with the following naming convention: `{package_id}-v{version}.cpa`.
185193

186-
### Publishing Packages
194+
### Publish Packages
187195

188196
Package archives can be published to the Marketplace Server using the `cmemc package publish` command.
197+
After being published packages can be found and installed directly from the Marketplace Server (potential users do not need to have the local package folder or `.cpa` file available).

docs/develop/marketplace-packages/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
status: new
33
title: "Marketplace Packages: Overview"
44
icon: material/shopping
5+
tags:
6+
- Package
57
hide:
68
- toc
79
---
@@ -15,7 +17,7 @@ Marketplace Packages bundle everything for a specific Corporate Memory–based s
1517
- Vocabularies / Ontologies
1618
- (SKOS) Taxonomies
1719
- (Instance / Data) Graphs
18-
- BUILD Projects
20+
- Build Projects
1921
- Dependencies on
2022
- [python-plugins](../python-plugins/index.md)
2123
- (other) Marketplace Packages
@@ -34,14 +36,14 @@ The following pages give an overview of this feature:
3436

3537
Intended for Linked Data Experts and Corporate Memory Admins, this page outlines how to (un)install and manage Marketplace Packages.
3638

37-
This section discusses the lifecycle commands and stages `copier copy`, _Package Definition and Release_, `inspect`, `install --input PATH` (from local), _Solution Development and Configuration_, `export`, `build`, and `publish`.
39+
This section discusses the lifecycle commands and stages `install`, `list` and `uninstall`.
3840

3941
- :material-code-json: [Development and Publication](development/index.md)
4042

4143
---
4244

4345
Intended for Linked Data Experts, Consultants, and Partners, this page gives an overview of how to start developing and publish Marketplace Packages.
4446

45-
This section discusses the lifecycle commands and stages `install`, `list` and `uninstall`.
47+
This section discusses the lifecycle commands and stages `copier copy`, _Package Definition and Release_, `inspect`, `install --input PATH` (from local), _Solution Development and Configuration_, `export`, `build`, and `publish`.
4648

4749
</div>

docs/develop/marketplace-packages/installation/index.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,48 @@
22
title: "Marketplace Packages: Installation and Management"
33
icon: material/download-circle-outline
44
tags:
5-
- Python
6-
- Plugin
5+
- Package
76
---
87
# Installation and Management of Marketplace Packages
98

10-
9+
## Introduction
10+
11+
Marketplace Packages can be installed directly from a Corporate Memory Marketplace Server or from local package archives (`.cpa` files).
12+
13+
This page describes how to install, list, and uninstall packages using `cmemc`.
14+
15+
!!! info "`cmemc package` reference"
16+
17+
Refer to [TODO: link](./) for the complete reference of the `package` command group.
18+
19+
## Install Packages
20+
21+
Use the following command to install a package from a Marketplace Server:
22+
23+
```sh
24+
cmemc package install PACKAGE_ID
25+
```
26+
27+
For installing local package archives (`.cpa` files) or package directories, use the `--input` option:
28+
29+
```sh
30+
cmemc package install --input PATH
31+
```
32+
33+
## List Packages
34+
35+
Use the following command to list all installed packages:
36+
37+
```sh
38+
cmemc package list
39+
```
40+
41+
## Uninstall Packages
42+
43+
Use the following command to uninstall a package:
44+
45+
```sh
46+
cmemc package uninstall PACKAGE_ID
47+
```
48+
49+
This removes all package contents from the Corporate Memory instance, including graphs and Build projects that were installed as part of the package.

0 commit comments

Comments
 (0)