You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/develop/marketplace-packages/development/index.md
+18-9Lines changed: 18 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: "Marketplace Packages: Development and Publication"
3
3
icon: material/code-json
4
4
tags:
5
-
- Python
5
+
- Package
6
6
---
7
7
# Development and Publication of Marketplace Packages
8
8
@@ -35,16 +35,16 @@ You can remove a license entirely; however, a package that does not declare a li
35
35
36
36
The `manifest.json` is the central package definition.
37
37
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.
39
39
40
40
#### Metadata
41
41
42
42
`package_type`
43
43
: `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.
45
45
46
46
`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.
48
48
49
49
`package_id`
50
50
: Unique package identifier
@@ -153,7 +153,7 @@ The following pages give an overview about this feature:
Make changes to graphs, configuration, or Build projects as needed.
165
165
Newly created or imported graphs or Build projects need to be registered in `manifest.json` so they will be fetched by `export`.
166
166
167
-
### Exporting Contents into a Package
167
+
### Export Contents into a Package
168
168
169
169
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.
170
170
171
171
```sh
172
172
cmemc package export PACKAGE_ID
173
173
```
174
174
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.
176
176
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
178
186
179
187
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.
180
188
@@ -183,6 +191,7 @@ This will build a package archive from a package directory.
183
191
184
192
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`.
185
193
186
-
### Publishing Packages
194
+
### Publish Packages
187
195
188
196
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).
Copy file name to clipboardExpand all lines: docs/develop/marketplace-packages/index.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
status: new
3
3
title: "Marketplace Packages: Overview"
4
4
icon: material/shopping
5
+
tags:
6
+
- Package
5
7
hide:
6
8
- toc
7
9
---
@@ -15,7 +17,7 @@ Marketplace Packages bundle everything for a specific Corporate Memory–based s
15
17
- Vocabularies / Ontologies
16
18
- (SKOS) Taxonomies
17
19
- (Instance / Data) Graphs
18
-
-BUILD Projects
20
+
-Build Projects
19
21
- Dependencies on
20
22
-[python-plugins](../python-plugins/index.md)
21
23
- (other) Marketplace Packages
@@ -34,14 +36,14 @@ The following pages give an overview of this feature:
34
36
35
37
Intended for Linked Data Experts and Corporate Memory Admins, this page outlines how to (un)install and manage Marketplace Packages.
36
38
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`.
38
40
39
41
- :material-code-json: [Development and Publication](development/index.md)
40
42
41
43
---
42
44
43
45
Intended for Linked Data Experts, Consultants, and Partners, this page gives an overview of how to start developing and publish Marketplace Packages.
44
46
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`.
0 commit comments