Skip to content

Commit 7f2b302

Browse files
KastanDaylmarini
andauthored
Fix HTML rendering of docs (#341)
* fixed yaml codeblock HTML render * fix typo * major copy improvements, added Apple Silicon install instructions * Revert "major copy improvements, added Apple Silicon install instructions" This reverts commit 06dc8e0. * reverted changelog. no need to update it Co-authored-by: Luigi Marini <[email protected]>
1 parent 31270b1 commit 7f2b302

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

doc/src/sphinx/userguide/installing_clowder.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -157,15 +157,15 @@ for details.), we must tell Clowder which ports the services are using.
157157
2. Copy and paste the lines below into that file we just created
158158
``docker-compose.override.yml``
159159

160-
.. code:: yml
160+
.. code-block:: yaml
161+
:caption: docker-compose.override.yml
161162
162-
# this lets Clowder communicate with the necessary services
163-
# These services (Mongo, RabbitMQ, ElsticSearch) will be run
164-
# via docker containers using the command line
163+
# this lets Clowder communicate with the necessary services (Mongo, RabbitMQ, ElsticSearch)
164+
# Each service runs as a docker container.
165165
166166
services:
167167
mongo:
168-
image: mongo:3.4
168+
image: mongo:3.6
169169
ports:
170170
- 27017:27017
171171
rabbitmq:
@@ -214,8 +214,8 @@ Part 2: Run Clowder via IntelliJ
214214
- This should prompt you to install the Scala plugin! Install it.
215215

216216
3. Install the Scala Plugin for IntelliJ ``File`` --> ``Settings`` --> ``Plugins`` --> ``Download Scala``.
217-
4. Install Java 8 on your computer (version 8 required, not compatible
218-
with other versions)
217+
4. Install Java 8 (i.e. Java 1.8) on your computer. Clowder requires Java version 8 and is not compatible
218+
with other versions.
219219

220220
- I find this easiest to do via IntelliJ’s Plugin Manager. ``File`` --> ``Project Structure`` --> ``SDKs`` --> ``+`` icon --> ``Download JDK``
221221
- Select ``Version 1.8`` (Clowder is only compatible with Java 8 (1.8), nothing higher) --> Vendor: ``Eclipse Temurin (AdoptOpenJDK Hotspot)`` --> ``Download``.
@@ -267,7 +267,7 @@ Also note, a handy debugging mode 🐞 is enabled by default. You can run the de
267267

268268
.. note::
269269

270-
Use ``localhost:9000`` when **building from source** (clicking the green play button ▶️ in IntelliJ).``
270+
Use ``localhost:9000`` when **building from source** (clicking the green play button ▶️ in IntelliJ).
271271

272272
Use ``localhost:8000`` when **running from Docker only** (via ``docker-compose up -d`` without building from source)
273273

0 commit comments

Comments
 (0)