Skip to content

Commit 8d905ab

Browse files
author
Marek Suchánek
committed
Add container installation instructions
1 parent b567f1a commit 8d905ab

File tree

1 file changed

+36
-22
lines changed

1 file changed

+36
-22
lines changed

docs/using-newdoc.adoc

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -65,37 +65,50 @@ To install `newdoc` on macOS, use the **Homebrew** package manager:
6565
$ brew install msuchane/repo/newdoc
6666
----
6767

68-
=== From source on any platform
68+
=== Container
6969

70-
To install `newdoc` from source on a Linux distribution, on macOS, or on Microsoft Windows, use the `cargo` package manager:
70+
To install `newdoc` as a container, use Docker or Podman.
7171

72-
. Install the Rust toolchain: see <https://rustup.rs/>.
72+
On Fedora, RHEL, and CentOS, replace `docker` with `podman` in the following commands:
7373

74-
. Install `newdoc`:
74+
. Download the image:
7575
+
7676
----
77-
$ cargo install newdoc
77+
$ docker pull quay.io/msuchane/newdoc
78+
----
79+
80+
. Configure a command alias. Save this line in your shell configuration file, such as in the `~/.bashrc` file:
81+
+
82+
----
83+
alias newdoc="podman run -it -v .:/mnt/newdoc:Z msuchane/newdoc newdoc"
7884
----
7985

86+
. Open a new terminal to reload the shell configuration.
87+
8088
. Test that `newdoc` works:
8189
+
8290
----
8391
$ newdoc
8492
----
8593

86-
////
87-
Note: The configuration files for a container image are still usable in the repo, but Docker Hub no longer provides free builds, so I'm disabling this part of instructions.
94+
=== From source on any platform
95+
96+
To install `newdoc` from source on a Linux distribution, on macOS, or on Microsoft Windows, use the `cargo` package manager:
97+
98+
. Install the Rust toolchain: see <https://rustup.rs/>.
8899

89-
* To install `newdoc` as a Docker image, use the `docker` or `podman` tool. If you use `podman`, replace `docker` with `podman` in the following commands:
100+
. Install `newdoc`:
90101
+
91102
----
92-
$ docker pull mrksu/newdoc
93-
94-
$ docker run mrksu/newdoc
103+
$ cargo install newdoc
95104
----
105+
106+
. Test that `newdoc` works:
96107
+
97-
WARNING: The container currently does not generate files properly. For details and a workaround, see [Issue #17](https://github.com/redhat-documentation/newdoc/issues/17).
98-
////
108+
----
109+
$ newdoc
110+
----
111+
99112

100113
== Updating newdoc
101114

@@ -147,6 +160,16 @@ $ brew update
147160
$ brew upgrade newdoc
148161
----
149162

163+
=== Container
164+
165+
To update the `newdoc` container, use Docker or Podman.
166+
167+
On Fedora, RHEL, and CentOS, replace `docker` with `podman` in the following command:
168+
169+
----
170+
$ docker pull quay.io/msuchane/newdoc
171+
----
172+
150173
=== From source on any platform
151174

152175
To update `newdoc` from source, use the `cargo` package manager:
@@ -163,15 +186,6 @@ $ rustup update
163186
$ cargo install newdoc
164187
----
165188

166-
////
167-
Note: The configuration files for a container image are still usable in the repo, but Docker Hub no longer provides free builds, so I'm disabling this part of instructions.
168-
169-
* To update `newdoc` from Docker, use the `docker` or `podman` tool:
170-
+
171-
----
172-
$ docker pull mrksu/newdoc
173-
----
174-
////
175189

176190
== Generating documentation files
177191

0 commit comments

Comments
 (0)