fgreg closed pull request #26: SDAP-130 Add note to quickstart URL: https://github.com/apache/incubator-sdap-nexus/pull/26
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): 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: ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
