ocket8888 commented on a change in pull request #4697:
URL: https://github.com/apache/trafficcontrol/pull/4697#discussion_r427049787
##########
File path: docs/source/development/traffic_portal.rst
##########
@@ -44,6 +44,32 @@ Installing The Traffic Portal Developer Environment
#. Navigate to the ``traffic_portal`` subdirectory of your cloned repository.
#. Run ``npm install`` to install application dependencies into
``traffic_portal/node_modules``. Only needs to be done the first time unless
``traffic_portal/package.json`` changes.
#. Run ``bower install`` to install client-side dependencies into
``traffic_portal/app/bower_components``. Only needs to be done the first time
unless ``traffic_portal/bower.json`` changes.
+#. Make sure that compass is installed and functioning correctly by running
``compass version``. If ``compass`` is not running, you can install it on
macOSas follows:
Review comment:
> _"... on macOSas follows..."_
^ missing space
##########
File path: docs/source/development/traffic_portal.rst
##########
@@ -44,6 +44,32 @@ Installing The Traffic Portal Developer Environment
#. Navigate to the ``traffic_portal`` subdirectory of your cloned repository.
#. Run ``npm install`` to install application dependencies into
``traffic_portal/node_modules``. Only needs to be done the first time unless
``traffic_portal/package.json`` changes.
#. Run ``bower install`` to install client-side dependencies into
``traffic_portal/app/bower_components``. Only needs to be done the first time
unless ``traffic_portal/bower.json`` changes.
+#. Make sure that compass is installed and functioning correctly by running
``compass version``. If ``compass`` is not running, you can install it on
macOSas follows:
+ #. macOS comes with its own version of ruby built into it. In order to
install compass, if you run a command like ``sudo gem install compass``, it
will take the default ruby available in mac. In order to properly install
compass, here is what you should be doing:
+ #. ``brew install ruby``
+ #. ``gem update --system``
+ #. ``gem install compass``
+ Note: You might need to install sass before you install compass. You
can do that by running:
+ #. ``gem install sass``
+ #. Make sure that compass and sass are part of your ``PATH`` environment
variable.
+ #. If not, you can see where gem installs compass and sass by running:
+ ``gem environment``
+ #. In there, you can see where ruby is installing all the gems. Add that
path to your ``PATH`` environment variable.
+ For ex, it is
``/usr/local/lib/ruby/gems/2.7.0/gems/compass-1.0.3/bin/`` for this test setup.
+ #. Once you have installed compass successfully, make sure you can reach
it by typing
+ ``compass version``
+ This should give a valid output. For ex, for the test setup, the output
is
+
+ ``Compass 1.0.3 (Polaris)``
+
+ ``Copyright (c) 2008-2020 Chris Eppstein``
+
+ ``Released under the MIT License.``
+
+ ``Compass is charityware.``
+
+ ``Please make a tax deductable donation for a worthy cause:
http://umdf.org/compass``
Review comment:
This looks like it should be a code block, not a bunch of single-line
paragraphs each containing an inline code span.
##########
File path: docs/source/development/traffic_portal.rst
##########
@@ -44,6 +44,32 @@ Installing The Traffic Portal Developer Environment
#. Navigate to the ``traffic_portal`` subdirectory of your cloned repository.
#. Run ``npm install`` to install application dependencies into
``traffic_portal/node_modules``. Only needs to be done the first time unless
``traffic_portal/package.json`` changes.
#. Run ``bower install`` to install client-side dependencies into
``traffic_portal/app/bower_components``. Only needs to be done the first time
unless ``traffic_portal/bower.json`` changes.
+#. Make sure that compass is installed and functioning correctly by running
``compass version``. If ``compass`` is not running, you can install it on
macOSas follows:
+ #. macOS comes with its own version of ruby built into it. In order to
install compass, if you run a command like ``sudo gem install compass``, it
will take the default ruby available in mac. In order to properly install
compass, here is what you should be doing:
+ #. ``brew install ruby``
+ #. ``gem update --system``
+ #. ``gem install compass``
+ Note: You might need to install sass before you install compass. You
can do that by running:
+ #. ``gem install sass``
+ #. Make sure that compass and sass are part of your ``PATH`` environment
variable.
+ #. If not, you can see where gem installs compass and sass by running:
+ ``gem environment``
+ #. In there, you can see where ruby is installing all the gems. Add that
path to your ``PATH`` environment variable.
+ For ex, it is
``/usr/local/lib/ruby/gems/2.7.0/gems/compass-1.0.3/bin/`` for this test setup.
+ #. Once you have installed compass successfully, make sure you can reach
it by typing
Review comment:
Missing a period at the end of this sentence.
##########
File path: docs/source/development/traffic_portal.rst
##########
@@ -44,6 +44,32 @@ Installing The Traffic Portal Developer Environment
#. Navigate to the ``traffic_portal`` subdirectory of your cloned repository.
#. Run ``npm install`` to install application dependencies into
``traffic_portal/node_modules``. Only needs to be done the first time unless
``traffic_portal/package.json`` changes.
#. Run ``bower install`` to install client-side dependencies into
``traffic_portal/app/bower_components``. Only needs to be done the first time
unless ``traffic_portal/bower.json`` changes.
+#. Make sure that compass is installed and functioning correctly by running
``compass version``. If ``compass`` is not running, you can install it on
macOSas follows:
+ #. macOS comes with its own version of ruby built into it. In order to
install compass, if you run a command like ``sudo gem install compass``, it
will take the default ruby available in mac. In order to properly install
compass, here is what you should be doing:
+ #. ``brew install ruby``
+ #. ``gem update --system``
+ #. ``gem install compass``
+ Note: You might need to install sass before you install compass. You
can do that by running:
+ #. ``gem install sass``
+ #. Make sure that compass and sass are part of your ``PATH`` environment
variable.
Review comment:
"compass" appears in code spans most everywhere else, should here too.
##########
File path: docs/source/development/traffic_portal.rst
##########
@@ -44,6 +44,32 @@ Installing The Traffic Portal Developer Environment
#. Navigate to the ``traffic_portal`` subdirectory of your cloned repository.
#. Run ``npm install`` to install application dependencies into
``traffic_portal/node_modules``. Only needs to be done the first time unless
``traffic_portal/package.json`` changes.
#. Run ``bower install`` to install client-side dependencies into
``traffic_portal/app/bower_components``. Only needs to be done the first time
unless ``traffic_portal/bower.json`` changes.
+#. Make sure that compass is installed and functioning correctly by running
``compass version``. If ``compass`` is not running, you can install it on
macOSas follows:
+ #. macOS comes with its own version of ruby built into it. In order to
install compass, if you run a command like ``sudo gem install compass``, it
will take the default ruby available in mac. In order to properly install
compass, here is what you should be doing:
+ #. ``brew install ruby``
+ #. ``gem update --system``
+ #. ``gem install compass``
+ Note: You might need to install sass before you install compass. You
can do that by running:
+ #. ``gem install sass``
+ #. Make sure that compass and sass are part of your ``PATH`` environment
variable.
+ #. If not, you can see where gem installs compass and sass by running:
+ ``gem environment``
+ #. In there, you can see where ruby is installing all the gems. Add that
path to your ``PATH`` environment variable.
+ For ex, it is
``/usr/local/lib/ruby/gems/2.7.0/gems/compass-1.0.3/bin/`` for this test setup.
Review comment:
"ex" means "exercise", not "example". "e.g." means "For example", but in
this context I'd recommend you just spell out "example".
##########
File path: docs/source/development/traffic_portal.rst
##########
@@ -44,6 +44,32 @@ Installing The Traffic Portal Developer Environment
#. Navigate to the ``traffic_portal`` subdirectory of your cloned repository.
#. Run ``npm install`` to install application dependencies into
``traffic_portal/node_modules``. Only needs to be done the first time unless
``traffic_portal/package.json`` changes.
#. Run ``bower install`` to install client-side dependencies into
``traffic_portal/app/bower_components``. Only needs to be done the first time
unless ``traffic_portal/bower.json`` changes.
+#. Make sure that compass is installed and functioning correctly by running
``compass version``. If ``compass`` is not running, you can install it on
macOSas follows:
+ #. macOS comes with its own version of ruby built into it. In order to
install compass, if you run a command like ``sudo gem install compass``, it
will take the default ruby available in mac. In order to properly install
compass, here is what you should be doing:
+ #. ``brew install ruby``
+ #. ``gem update --system``
+ #. ``gem install compass``
+ Note: You might need to install sass before you install compass. You
can do that by running:
+ #. ``gem install sass``
+ #. Make sure that compass and sass are part of your ``PATH`` environment
variable.
+ #. If not, you can see where gem installs compass and sass by running:
Review comment:
"compass" appears in code spans most everywhere else, should here too.
##########
File path: docs/source/development/traffic_portal.rst
##########
@@ -44,6 +44,32 @@ Installing The Traffic Portal Developer Environment
#. Navigate to the ``traffic_portal`` subdirectory of your cloned repository.
#. Run ``npm install`` to install application dependencies into
``traffic_portal/node_modules``. Only needs to be done the first time unless
``traffic_portal/package.json`` changes.
#. Run ``bower install`` to install client-side dependencies into
``traffic_portal/app/bower_components``. Only needs to be done the first time
unless ``traffic_portal/bower.json`` changes.
+#. Make sure that compass is installed and functioning correctly by running
``compass version``. If ``compass`` is not running, you can install it on
macOSas follows:
+ #. macOS comes with its own version of ruby built into it. In order to
install compass, if you run a command like ``sudo gem install compass``, it
will take the default ruby available in mac. In order to properly install
compass, here is what you should be doing:
+ #. ``brew install ruby``
+ #. ``gem update --system``
+ #. ``gem install compass``
+ Note: You might need to install sass before you install compass. You
can do that by running:
Review comment:
Missing blank lines; this causes rendering issues.
Also, this is a note, and so should be using the `.. note::` directive, or
possibly the `.. tip::` directive if more appropriate
Also also, you made the step that this optional admonition contains a part
of the overall process. So if this is truly optional, then the optional step
should be contained in the admonition, and if it isn't then this admonition
should not exist.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
