clowder-framework / clowder

A data management system that allows users to share, annotate, organize and analyze large collections of datasets. It provides support for extensible metadata annotation using JSON-LD and a distribute analytics event bus for automatic curation of uploaded data.
https://clowderframework.org/
University of Illinois/NCSA Open Source License
35 stars 17 forks source link

[BUG] Some code blocks in the installation instructions are not rendering #329

Closed sandeep-ps closed 2 years ago

sandeep-ps commented 2 years ago

Describe the bug Some code blocks in the installation instructions on the Read The Docs page are not rendering.

To Reproduce Steps to reproduce the behavior:

  1. Go to https://clowder-framework.readthedocs.io/en/latest/userguide/installing_clowder.html
  2. Scroll down to https://clowder-framework.readthedocs.io/en/latest/userguide/installing_clowder.html#expose-docker- services-ports-to-clowder
  3. See that the code blocks are missing (see screenshot below.)

Expected behavior All code blocks need to render correctly.

Screenshots image

Desktop (please complete the following information):

Additional context Relevant RST file section: https://github.com/clowder-framework/clowder/blob/develop/doc/src/sphinx/userguide/installing_clowder.rst#expose-docker-services-ports-to-clowder

KastanDay commented 2 years ago

As far as I can tell, this is the only code block that is missing in the HTML render.

The offending block looks like:

.. code:: yml

   # this lets Clowder communicate with the necessary services
   # These services (Mongo, RabbitMQ, ElsticSearch) will be run 
   # via docker containers using the command line

   services:
     mongo:
       image: mongo:3.4
       ports:
         - 27017:27017
     rabbitmq:
       image: rabbitmq:management-alpine
       ports:
         - 5672:5672
         - 15672:15672
     elasticsearch:
       image: elasticsearch:2
       ports:
         - 9200:9200
         - 9300:9300

Possible causes:

I think the fix is: .. code:: yaml (simply spelling out 'yaml')

I will test locally, then submit a PR.

sandeep-ps commented 2 years ago

Good catch, @KastanDay!