Skip to content

Commit f004031

Browse files
authored
Merge pull request #63201 from janisz/Add-information-about-building-with-docker
Add information about building with docker
2 parents 4f7389a + e4cd972 commit f004031

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

contributing_to_docs/tools_and_setup.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,20 @@ of the box, but if you are on Windows you can use http://cygwin.com/[Cygwin])
7777
* An editor that can strip trailing whitespace, such as
7878
link:https://code.visualstudio.com/[Visual Studio Code].
7979

80+
=== Building using the asciibinder container image
81+
82+
. Install the _docker_ or _link:https://podman.io/docs/installation[Podman]_ package.
83+
. Change to the `openshift-docs` directory and build every distribution by entering the `run` command for the tool that you are using. The following example uses Docker and is identical for Podman on Linux. This example might require some setup on a Mac.
84+
+
85+
----
86+
$ cd openshift-docs
87+
$ docker run --rm -it -v `pwd`:/docs:Z quay.io/openshift-cs/asciibinder asciibinder build
88+
----
89+
. Open the generated HTML file in your web browser. This will be located in the
90+
`openshift-docs/_preview/<distro>/<branch>` directory, with the same path and
91+
filename as the original `.adoc` file you edited, but with an
92+
`.html` extension.
93+
8094
=== Install the required software dependencies on a Linux system
8195
The following instructions describe how to install all the required tools to do
8296
live content editing on a Fedora Linux system.

0 commit comments

Comments
 (0)