Skip to content

Commit 665a424

Browse files
committed
Update tools page
- macOS guidance now doesn't seem so shaky. - Default to podman - Link out to podman installation docs for non-Fedora OSes
1 parent a569396 commit 665a424

File tree

1 file changed

+37
-17
lines changed

1 file changed

+37
-17
lines changed

contributing_to_docs/tools_and_setup.adoc

+37-17
Original file line numberDiff line numberDiff line change
@@ -59,26 +59,14 @@ $ git remote add upstream [email protected]:openshift/openshift-docs.git
5959
This ensures that you are tracking the remote repository to keep your local
6060
repository in sync with it.
6161

62-
== Install Podman or Docker and run AsciiBinder as a container image
62+
== Previewing the documentation locally
6363

64-
When you have the documentation repository cloned and set up, you are ready to
65-
install the software and tools you will use to create the content. All OpenShift
66-
documentation is created in AsciiDoc, and is processed with https://github.com/redhataccess/ascii_binder[AsciiBinder],
64+
After you clone the documentation repository, you are ready to
65+
install the software you need to build our content from source. All OpenShift
66+
documentation is written in AsciiDoc, and is processed with https://github.com/redhataccess/ascii_binder[AsciiBinder],
6767
which is an http://asciidoctor.org/[AsciiDoctor]-based docs management system.
6868

69-
The recommended way to run AsciiBinder is on a container image using Podman or Docker.
70-
71-
. Install the _docker_ or _link:https://podman.io/docs/installation[Podman]_ package.
72-
. 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.
73-
+
74-
----
75-
$ cd openshift-docs
76-
$ docker run --rm -it -v `pwd`:/docs:Z quay.io/openshift-cs/asciibinder asciibinder build
77-
----
78-
. Open the generated HTML file in your web browser. This will be located in the
79-
`openshift-docs/_preview/<distro>/<branch>` directory, with the same path and
80-
filename as the original `.adoc` file you edited, but with an
81-
`.html` extension.
69+
The recommended way to run AsciiBinder is on a container image using link:https://podman.io/[Podman]. However, if you already have Docker on your system, you can use it in place of Podman.
8270

8371
[IMPORTANT]
8472
====
@@ -87,6 +75,38 @@ Previously, installing AsciiBinder directly on your system was recommended. Howe
8775
Use AsciiBinder by running the container image.
8876
====
8977

78+
=== Installing Podman on your system
79+
80+
Install Podman so that you can run the AsciiBinder container image on your machine.
81+
82+
If you are using Fedora, from a command line, enter:
83+
84+
[source,terminal]
85+
----
86+
$ sudo dnf install podman
87+
----
88+
89+
If you are using another operating system, follow the link:https://podman.io/docs/installation[Podman installation docs].
90+
91+
=== Building the documentation
92+
93+
Run the container image with an AsciiBinder command to build the OpenShift documentation.
94+
95+
. From a command line, change to the `openshift-docs` directory.
96+
97+
. To build every distribution in the docs, enter the following command:
98+
+
99+
[source,terminal]
100+
----
101+
$ podman run --rm -it -v `pwd`:/docs:Z quay.io/openshift-cs/asciibinder asciibinder build
102+
----
103+
+
104+
The `asciibinder build` command runs within the image. The AsciiDoc files are transformed into HTML files in your local repository under the `_preview` directory. By default, AsciiBinder generates a documentation set for each distribution.
105+
106+
TIP: To choose which link:https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#product-title-and-version[distributions] to build, use the `-d` option in the command. For example, to only build `openshift-enterprise`, change `asciibinder build` to `asciibinder build -d openshift-enterprise`.
107+
108+
109+
90110
== Next steps
91111
With the repository and tools set up on your workstation, you can now either
92112
edit existing content or create assemblies and modules.

0 commit comments

Comments
 (0)