This is an automated email from the ASF dual-hosted git repository.
fgreg pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-sdap-nexus.git
The following commit(s) were added to refs/heads/master by this push:
new 00978be Added note about needing to re-export VERSION
00978be is described below
commit 00978beba7a100952a12d9ab9f2cfd3d6b10aceb
Author: fgreg <[email protected]>
AuthorDate: Wed Aug 22 12:27:30 2018 -0700
Added note about needing to re-export VERSION
---
README.md | 14 ++++++++++++--
docs/quickstart.rst | 2 ++
2 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index fbc68ab..88d1aae 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,15 @@
-NEXUS
-=====
+# NEXUS
The next generation cloud-based science data service platform. More
information can be found here
http://incubator-sdap-nexus.readthedocs.io/en/latest/index.html
+
+## Building the Docs
+
+Ensure sphinx and sphinx-autobuild are installed
+
+ pip install sphinx sphinx-autobuild
+
+Run sphinx-autobuild to view the docs locally.
+
+ cd docs
+ sphinx-autobuild . _build/html
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
index 1e66939..3f53dd5 100644
--- a/docs/quickstart.rst
+++ b/docs/quickstart.rst
@@ -255,6 +255,8 @@ Now that the data is being (has been) ingested, we need to
start the webapp that
docker run -d --name nexus-webapp --network sdap-net -p 8083:8083 -e
SPARK_LOCAL_IP=127.0.0.1 -e MASTER=local[4] -e
CASSANDRA_CONTACT_POINTS=cassandra -e SOLR_URL_PORT=solr:8983
sdap/nexus-webapp:${VERSION}
+.. note:: If you see a messasge like ``docker: invalid reference format`` it
likely means you need to re-export the ``VERSION`` environment variable again.
This can happen when you open a new terminal window or tab.
+
This command starts the nexus webservice and connects it to the Solr and
Cassandra containers. It also sets the configuration for Spark to use local
mode with 4 executors.
After running this command you should be able to access the NEXUS webservice
by sending requests to http://localhost:8083. A good test is to query the
``/list`` endpoint which lists all of the datasets currently available to that
instance of NEXUS. For example:
