Skip to content

Commit

Permalink
feat: begin work on container image docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sgammon committed May 16, 2024
1 parent a4c79dd commit b10bacd
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
4 changes: 1 addition & 3 deletions Writerside/e.tree
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
<toc-element topic="Ruby.md"/>
<toc-element topic="Experimental.md"/>
</toc-element>
<toc-element topic="Container-Images.md"/>
</toc-element>
<toc-element topic="Elide-Framework.md">
<toc-element topic="Framework-Samples.md"/>
Expand All @@ -85,9 +86,6 @@
</toc-element>
</toc-element>
<toc-element toc-title="Usage Guides">
<toc-element topic="Tutorial.md"/>
<toc-element topic="How-to.md"/>
<toc-element topic="Overview.md"/>
</toc-element>
<toc-element topic="Architecture.md">
<toc-element topic="Execution.md"/>
Expand Down
3 changes: 3 additions & 0 deletions Writerside/topics/Container-Images.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Container Images

Coming soon.
13 changes: 12 additions & 1 deletion Writerside/topics/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,16 @@ Follow the steps below if you're having trouble installing %product%:
</step>
</procedure>

## Container Images

%product% ships as container images, too. You can use %product% from Docker:

```Console
docker run --rm -it ghcr.io/elide-dev/elide
```

> Read more about container images provided by %product% on the [Container Images](Container-Images.md) page.
## Known Limitations

On certain OS or OS/arch pairs, %product% may not have full support for every feature. Consult the sections below for
Expand All @@ -142,7 +152,8 @@ Certain features are not supported on macOS yet:

## Framework Installation


To use %product% as a JVM framework, see the [%product% Framework](Elide-Framework.md) docs. Generally speaking, library
modules are installed as Maven dependencies.

<seealso>
<category ref="gettingStarted">
Expand Down

0 comments on commit b10bacd

Please sign in to comment.