Skip to content

Commit 191132e

Browse files
authored
Add instructions for using toolbox and asciibinder to repo tools doc (#55776)
* Add instructions for using toolbox for asciibinder * Add Podman version note
1 parent 8fb4020 commit 191132e

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

contributing_to_docs/tools_and_setup.adoc

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,54 @@ NOTE: If you already have AsciiBinder installed, you might be due for an update.
104104
These directions assume that you are using AsciiBinder 0.2.0 or newer. To check
105105
and update if necessary, simply run `gem update ascii_binder`. Note that you might require root permissions.
106106

107+
=== Install the required software dependencies in a toolbox container on Linux
108+
109+
You can use link:https://containertoolbx.org/[`toolbx`] to create a Fedora-based container for our tools on most Linux distributions, including RHEL. By using Fedora as the base, you have access to relatively recent versions of required software packages.
110+
111+
.Prerequisites
112+
113+
* Your distro has link:https://podman.io/[Podman] 1.4.0 or greater.
114+
115+
.Procedure
116+
117+
. If you don't already have `toolbx`, link:https://containertoolbx.org/install/[install it].
118+
119+
. To create a Fedora 37 container, on a command line, enter:
120+
+
121+
[source,terminal]
122+
----
123+
$ toolbox create --distro fedora --release f37 <container_name>
124+
----
125+
+
126+
where:
127+
128+
<container_name>:: Specifies the name that you want to give your toolbox container.
129+
130+
. Enter the container. From the command line, run:
131+
+
132+
[source,terminal]
133+
----
134+
$ toolbox enter <container_name>
135+
----
136+
137+
. Install dependencies for our tools. Within the toolbox that you entered, run:
138+
+
139+
[source,terminal]
140+
----
141+
[toolbox] $ sudo dnf install ruby-devel gcc-c++ redhat-rpm-config make
142+
----
143+
144+
. Install the required Ruby gems:
145+
+
146+
[source,terminal]
147+
----
148+
[toolbox] $ gem install ascii_binder asciidoctor-diagram
149+
----
150+
151+
You now have a toolbox container that you can use to build our documentation no matter which distribution you use.
152+
153+
NOTE: Press *Ctrl + D* or enter `exit` to exit the container. To use AsciiBinder or update the software in the container, remember to `toolbox enter <container_name>` first.
154+
107155
=== Building the collection
108156
With the initial setup complete, you are ready to build the collection.
109157

0 commit comments

Comments
 (0)