Skip to content

Commit 3ba67c5

Browse files
committed
minor edits
1 parent 48f1f2f commit 3ba67c5

1 file changed

Lines changed: 14 additions & 11 deletions

File tree

lang/en/docs/tutorials/contribute-new-application.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,12 @@ application to the Mat3ra platform so that it becomes a first-class option in
2121
both the web-interface and the [Command Line Interface (CLI)](/cli/overview).
2222

2323
This task involves adding necessary configurations to two repositories via pull
24-
requests. A basic understanding of container technologies (Apptainer,
25-
Singularity, or Docker), a GitHub account, Node.js installed locally, and a
26-
working Apptainer `.def` file are required before proceeding. If you need help
27-
with preparing Apptainer definition, please consult the [Add Software](
28-
/cli/actions/add-software) page first.
24+
requests. A basic understanding of container technologies (such as Apptainer,
25+
Singularity, or Docker), a GitHub account, [Node.js](https://nodejs.org)
26+
installed in local development machine, and a working Apptainer `.def` file are
27+
required before proceeding. If you need help with preparing Apptainer
28+
definition, please consult the [Add Software](/cli/actions/add-software) page
29+
first.
2930

3031

3132
![Application Selection in Web-Interface](../../../../images/tutorials/new-application/application-selection-web-ui.webp "Application Selection in Web-Interface")
@@ -83,8 +84,9 @@ flowchart TB
8384

8485
### 2.1. Fork and clone the repository
8586

86-
First, fork `github.com/Exabyte-io/application-containers-public` on GitHub,
87-
then clone the fork locally. The top-level layout is:
87+
First, fork [github.com/Exabyte-io/application-containers-public](
88+
https://github.com/Exabyte-io/application-containers-public) on GitHub, then
89+
clone the fork locally. The top-level layout is:
8890

8991
```
9092
application-containers-public/
@@ -158,8 +160,8 @@ The three fields are:
158160
- `path` → location of the `.def` file relative to the repository root.
159161
- `tag` → follows the convention `<version>-<toolchain>-<N>` where `N` is a
160162
build iteration starting from `0`. Bump `N` whenever the recipe changes
161-
without a version change; the CI treats tags as immutable and skips a build
162-
if the tag already exists.
163+
without a version change for the application; the CI treats tags as immutable
164+
and skips a build if the tag already exists.
163165

164166
### 2.4. Open the pull request and verify the build
165167

@@ -193,7 +195,8 @@ The image name, and tag are needed in the next section.
193195

194196
### 3.1. Fork and clone the repository
195197

196-
Fork `github.com/Exabyte-io/standata` and clone locally. The relevant subtree is:
198+
Fork [github.com/Exabyte-io/standata](https://github.com/Exabyte-io/standata)
199+
and clone locally. The relevant subtree is:
197200

198201
```
199202
assets/applications/
@@ -409,7 +412,7 @@ application is also available via modulefile for CLI use.
409412

410413
## 5. References
411414

412-
- Local recipe authoring: [Add Software](/cli/actions/add-software)
415+
- Apptainer Definition and container building: [Adding New Software](/cli/actions/add-software)
413416
- Container repository: [github.com/Exabyte-io/application-containers-public](https://github.com/Exabyte-io/application-containers-public)
414417
- Metadata repository: [github.com/Exabyte-io/standata](https://github.com/Exabyte-io/standata)
415418
- Published images: [Exabyte-io packages on GHCR](https://github.com/orgs/Exabyte-io/packages?repo_name=application-containers-public)

0 commit comments

Comments
 (0)