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/using-newdoc.adoc
+36-22Lines changed: 36 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,37 +65,50 @@ To install `newdoc` on macOS, use the **Homebrew** package manager:
65
65
$ brew install msuchane/repo/newdoc
66
66
----
67
67
68
-
=== From source on any platform
68
+
=== Container
69
69
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.
71
71
72
-
. Install the Rust toolchain: see <https://rustup.rs/>.
72
+
On Fedora, RHEL, and CentOS, replace `docker` with `podman` in the following commands:
73
73
74
-
. Install `newdoc`:
74
+
. Download the image:
75
75
+
76
76
----
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"
78
84
----
79
85
86
+
. Open a new terminal to reload the shell configuration.
87
+
80
88
. Test that `newdoc` works:
81
89
+
82
90
----
83
91
$ newdoc
84
92
----
85
93
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/>.
88
99
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`:
90
101
+
91
102
----
92
-
$ docker pull mrksu/newdoc
93
-
94
-
$ docker run mrksu/newdoc
103
+
$ cargo install newdoc
95
104
----
105
+
106
+
. Test that `newdoc` works:
96
107
+
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
+
99
112
100
113
== Updating newdoc
101
114
@@ -147,6 +160,16 @@ $ brew update
147
160
$ brew upgrade newdoc
148
161
----
149
162
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
+
150
173
=== From source on any platform
151
174
152
175
To update `newdoc` from source, use the `cargo` package manager:
@@ -163,15 +186,6 @@ $ rustup update
163
186
$ cargo install newdoc
164
187
----
165
188
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:
0 commit comments