Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docker documentation #357

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ This project adheres to the Contributor [Covenant code of conduct](CODE_OF_CONDU
* [JNet usage](src/documentation/articles/usage.md)
* [JNet APIs extensibility](src/documentation/articles/API_extensibility.md)
* [JNet CLI usage](src/documentation/articles/usageCLI.md)
* [JNet Docker usage](src/documentation/articles/docker.md)
* [JNet Reflector usage](src/documentation/articles/usageReflector.md)
* [JNet PowerShell usage](src/documentation/articles/usagePS.md)

Expand Down
9 changes: 9 additions & 0 deletions src/documentation/articles/docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Docker images of Java/JVM suite for .NET
_description: Describes the Docker images of Java/JVM suite for .NET
---

# JNet: Docker images

Java/JVM suite for .NET comes with some ready made Docker images:
- JNet CLI: see [JNet CLI usage](usageCLI.md)
2 changes: 2 additions & 0 deletions src/documentation/articles/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
href: usage.md
- name: JNet CLI usage
href: usageCLI.md
- name: JNet Docker images
href: docker.md
- name: JNet Reflector usage
href: usageReflector.md
- name: JNet PowerShell usage
Expand Down
6 changes: 4 additions & 2 deletions src/documentation/articles/usageCLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ _description: Describes JNet CLI tool: the CLI tool to use Java/JVM classes from

- **dotnet tool** hosted on NuGet.org: check https://www.nuget.org/packages/MASES.JNetCLI/ and https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools for installation deep instructions.
* The dotnet tool version needs and installed JRE/JDK within the system (see [JVM identification](#jvm-identification))
- **Docker image** hosted on https://github.com/masesgroup/JNet/pkgs/container/mases.jnet: follow instruction within the page and general instruction on https://docs.docker.com
- **Docker image** hosted on [GitHub](https://github.com/masesgroup/JNet/pkgs/container/jnet) or [Docker Hub](https://hub.docker.com/repository/docker/masesgroup/jnet/general): follow instruction within the page and general instruction on https://docs.docker.com
* The image hosts both .NET 6 and JRE 17 runtimes

## Usage
Expand All @@ -22,7 +22,9 @@ To use the CLI interface (JNetCLI) runs a command like the following:

- **Docker image**

> docker run ghcr.io/masesgroup/mases.jnet -i
> docker run ghcr.io/masesgroup/jnet -i

> docker run masesgroup/jnet -i

## Command switch available

Expand Down
1 change: 1 addition & 0 deletions src/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ This project adheres to the Contributor [Covenant code of conduct](CODE_OF_CONDU
* [JNet usage](articles/usage.md)
* [JNet APIs extensibility](articles/API_extensibility.md)
* [JNet CLI usage](articles/usageCLI.md)
* [JNet Docker usage](articles/docker.md)
* [JNet Reflector usage](articles/usageReflector.md)
* [JNet PowerShell usage](articles/usagePS.md)

Expand Down
Loading