Skip to content

Commit 0fe0848

Browse files
committed
Improved readability by making use of ..note: blocks
1 parent 7fe6335 commit 0fe0848

File tree

1 file changed

+42
-16
lines changed

1 file changed

+42
-16
lines changed

doc/src/sphinx/admin/getting_started.rst

Lines changed: 42 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tested. Production instances usually use the second method of installation :ref:
99
most extractors are deployed using `Docker swarm <https://docs.docker.com/engine/swarm/>`_.
1010

1111
What type of user are you?
12-
===============
12+
===================================
1313

1414

1515
For **users of Clowder**: Clowder is easily accessed via Docker. :ref:`Quickstart here<usersOfClowder>`.
@@ -33,7 +33,7 @@ recommended.
3333
.. _usersOfClowder:
3434

3535
Users of Clowder: Getting Started via Docker
36-
===================================
36+
==============================================
3737

3838
1. Install `Docker <http://docker.com/>`__ (if you haven’t already)
3939
2. Download and unzip the `latest stable version here <Download and unzip a specific version: Latest stable version.>`_
@@ -90,12 +90,24 @@ First, edit these properties to your liking:
9090
9191
docker run --rm -ti --network clowder_clowder -e FIRST_NAME=Admin -e LAST_NAME=User -e [email protected] -e PASSWORD=catsarecute -e ADMIN=true clowder/mongo-init
9292
93+
Now you can login to Clowder in your browser via ``localhost:8000`` (or if you built from source in IntelliJ, use ``localhost:9000``).
94+
9395
- If you get error: ``Error response from daemon: network clowder_clowder not found.``
9496
- Try changing the network parameter to ``--network clowder-1_clowder``. It's possible you have multiple Clowder docker containers.
9597

96-
Now you can login to Clowder in your browser via ``localhost:8000`` (or if you built from source in IntelliJ, use ``localhost:9000``).
98+
Done! You should be able to login to your new account, create new Spaces & Datasets and upload many different types of data.
99+
100+
.. note::
101+
Before you go, check out useful information like the `Clowder 'All Paws' YouTube playist <https://www.youtube.com/playlist?list=PLVhslX3lYajMZD9KA-RJK-ulmXys8d13i>`__.
102+
103+
- `Check out the Overview of Clowder <https://www.youtube.com/watch?v=B5hD8ehENck&list=PLVhslX3lYajMZD9KA-RJK-ulmXys8d13i&index=5&ab_channel=ClowderFramework>`__
104+
- `Check out How to use Clowder <https://www.youtube.com/watch?v=wHmDJAD5GbE&list=PLVhslX3lYajMZD9KA-RJK-ulmXys8d13i&index=5&t=605s&ab_channel=ClowderFramework>`__
105+
- `Check out How to Create a New Extractor <https://www.youtube.com/watch?v=0uthTzrZCt8&list=PLVhslX3lYajMZD9KA-RJK-ulmXys8d13i&index=17&ab_channel=ClowderFramework>`__
106+
- and 28 total videos covering specific Clowder topics and uses!
107+
108+
Or, try the `core data extractors <https://github.com/clowder-framework/extractors-core>`__ that most people would like to install.
109+
97110

98-
Check out the `next steps below <nextSteps>`_ !
99111

100112
.. _clowderDevelopers:
101113

@@ -214,14 +226,18 @@ Part 2: Run Clowder via IntelliJ
214226
215227
7. Create a new ``Play 2 App`` configuration
216228
217-
- Note: if you **don’t see Play 2 App in the list**, you may need to use IntelliJ *Ultimate* version (instead of Community). I experienced this bug, feel free to ask in the Clowder Slack.
229+
.. note::
230+
231+
If you **don’t see Play 2 App in the list**, you may need to use IntelliJ *Ultimate* version (instead of Community). I experienced this bug, feel free to ask in the `Clowder Slack here <https://join.slack.com/t/clowder-software/shared_invite/enQtMzQzOTg0Nzk3OTUzLTYwZDlkZDI0NGI4YmI0ZjE5MTZiYmZhZTIyNWE1YzM0NWMwMzIxODNhZTA1Y2E3MTQzOTg1YThiNzkwOWQwYWE>`_.
218232
219-
.. figure:: ../_static/GettingStarted_Play2Config.png
220-
:alt: Create play2 configuration.
233+
.. figure:: ../_static/GettingStarted_Play2Config.png
234+
:alt: Create play2 configuration.
221235
222236
8. The default configuration should be okay, see image below.
223237
224-
- NOTE: Later, **if Clowder feels slow** (multiple seconds per page load) then you will need to add JNotify to your JVM Options here. :ref:`Instructions at bottom of this page<slowClowder>`.
238+
.. note::
239+
240+
Later, **if Clowder feels slow** (multiple seconds per page load) then you will need to add JNotify to your JVM Options on this page. :ref:`Instructions at bottom of this page<slowClowder>`.
225241
226242
.. figure:: ../_static/GettingStarted_AddJDK.png
227243
:alt: Specify the JDK path
@@ -241,8 +257,11 @@ Now in IntelliJ, click the green play button (top right) to build Clowder from s
241257
Access Clowder via ``localhost:9000`` in the
242258
browser.
243259
244-
- Note: building from source defaults to port 9000. Running from Docker
245-
(without building from source) defaults to port 8000.
260+
.. note::
261+
262+
Use ``localhost:9000`` when building from source (clicking the green play button in IntelliJ) and running the services via ``docker-compose -f docker-compose.override.yml up -d``
263+
264+
Use ``localhost:8000`` when running from Docker only (without building from source) via ``docker-compose up -d``
246265
247266
.. _creatingLocalAccount
248267
Creating a local Clowder account
@@ -312,8 +331,8 @@ Now the below methods will work.
312331
Method 2: Creating many users? Change default Activation
313332
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
314333
315-
All accounts must also be **activated by an administrator. To activate
316-
your account by default, edit ``application.conf``**
334+
**All accounts must also be activated by an administrator. To activate
335+
your account by default, edit** ``application.conf``.
317336
318337
.. code:: bash
319338
@@ -407,9 +426,6 @@ here <https://opensource.ncsa.illinois.edu/confluence/display/CATS/JVM+Configura
407426
408427
- Simply download JNotify and tell IntelliJ where it is.
409428
410-
411-
.. _nextSteps:
412-
413429
Next Steps
414430
==========
415431
@@ -454,6 +470,15 @@ own <https://opensource.ncsa.illinois.edu/confluence/display/CATS/Extractors>`__
454470
455471
456472
473+
474+
475+
476+
477+
478+
479+
480+
481+
457482
Customize Deployment
458483
=================
459484
@@ -518,8 +543,9 @@ For example the following ``play.plugins`` file will enable some additional plug
518543
519544
.. _requirements:
520545
546+
******
521547
Requirements
522-
=================
548+
******
523549
524550
Following is a list of requirements for the Clowder software. Besides Java, all other services/software
525551
can be installed on other machines with Clowder configured to communicate with them.

0 commit comments

Comments
 (0)