summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgjoranv <gjoranv@gmail.com>2017-07-13 13:57:48 +0200
committerGitHub <noreply@github.com>2017-07-13 13:57:48 +0200
commitcde9f0d3fc9c5c322a100092318b020b238120ed (patch)
treec0a8a8187c1fc0da45db9424f3dc917e33addac0
parent8311fd26b7d51cce05d49c16340d0fe54a33501c (diff)
parent3988650fa65b58dedbb8c6366aaa2af0f56edbe7 (diff)
Merge pull request #2953 from yahoo/geirst/minor-fixes-to-sample-apps
Geirst/minor fixes to sample apps
-rw-r--r--sample-apps/README.md11
-rw-r--r--sample-apps/basic-search-java/README.md2
-rw-r--r--sample-apps/basic-search-tensor/README.md2
-rw-r--r--sample-apps/basic-search/README.md2
-rw-r--r--sample-apps/blog-recommendation/README.md2
-rw-r--r--sample-apps/blog-search/README.md2
-rw-r--r--sample-apps/http-api-using-request-handlers-and-processors/README.md2
-rw-r--r--sample-apps/http-api-using-searcher/README.md2
8 files changed, 17 insertions, 8 deletions
diff --git a/sample-apps/README.md b/sample-apps/README.md
index 36ca22e5a4b..6fab8cdba77 100644
--- a/sample-apps/README.md
+++ b/sample-apps/README.md
@@ -1,2 +1,11 @@
# Vespa sample applications
-This is the home of Vespa Sample applications
+
+This is a set of applications that showcase different Vespa features.
+Please refer to the
+[vespa quick start guide](https://git.corp.yahoo.com/pages/vespa/documentation/documentation/vespa-quick-start.html)
+to get started.
+
+Note: The applications that contain a pom.xml file must be built before being deployed.
+Please refer to
+[developing applications](https://git.corp.yahoo.com/pages/vespa/documentation/documentation/jdisc/developing-applications.html#deploy)
+for more information.
diff --git a/sample-apps/basic-search-java/README.md b/sample-apps/basic-search-java/README.md
index ff7f27196dd..e3eeb2f0407 100644
--- a/sample-apps/basic-search-java/README.md
+++ b/sample-apps/basic-search-java/README.md
@@ -4,6 +4,6 @@ A simple stateless Vespa application with no data, to demonstrate how to build
plugins for the Vespa JDisc container.
Please refer to
-[https://git.corp.yahoo.com/pages/vespa/documentation/documentation/jdisc/developing-applications.html](developing applications)
+[developing applications](https://git.corp.yahoo.com/pages/vespa/documentation/documentation/jdisc/developing-applications.html)
for more information.
diff --git a/sample-apps/basic-search-tensor/README.md b/sample-apps/basic-search-tensor/README.md
index 5ab21b8ca6a..9479f3955d2 100644
--- a/sample-apps/basic-search-tensor/README.md
+++ b/sample-apps/basic-search-tensor/README.md
@@ -8,6 +8,6 @@ Also includes the rank expression playground. Deploy the app, and open:
http://<host>:<port>/playground/index.html
Please refer to the
-[https://git.corp.yahoo.com/pages/vespa/documentation/documentation/tensor-user-guide.html](tensor user guide)
+[tensor user guide](https://git.corp.yahoo.com/pages/vespa/documentation/documentation/tensor-user-guide.html)
for more information.
diff --git a/sample-apps/basic-search/README.md b/sample-apps/basic-search/README.md
index e6354666ae2..7f41a748c95 100644
--- a/sample-apps/basic-search/README.md
+++ b/sample-apps/basic-search/README.md
@@ -4,6 +4,6 @@ A simple Vespa application which can be deployed on one node, which supports
feeding and running simple queries.
Please refer to the
-[https://git.corp.yahoo.com/pages/vespa/documentation/documentation/vespa-quick-start.html](vespa quick start guide)
+[vespa quick start guide](https://git.corp.yahoo.com/pages/vespa/documentation/documentation/vespa-quick-start.html)
for more information.
diff --git a/sample-apps/blog-recommendation/README.md b/sample-apps/blog-recommendation/README.md
index afcde20b003..3adcd158acc 100644
--- a/sample-apps/blog-recommendation/README.md
+++ b/sample-apps/blog-recommendation/README.md
@@ -3,7 +3,7 @@
This sample application contains the code for the blog recommendation tutorial.
Please refer to
-[https://git.corp.yahoo.com/pages/vespa/documentation/documentation/tutorials/blog-recommendation.html](Vespa tutorial pt.2 - Blog recommendation)
+[Vespa tutorial pt.2 - Blog recommendation](https://git.corp.yahoo.com/pages/vespa/documentation/documentation/tutorials/blog-recommendation.html)
for more information.
diff --git a/sample-apps/blog-search/README.md b/sample-apps/blog-search/README.md
index 0a5d861dc8f..a5fe2da414b 100644
--- a/sample-apps/blog-search/README.md
+++ b/sample-apps/blog-search/README.md
@@ -3,7 +3,7 @@
This sample application contains the code for the blog search tutorial.
Please refer to
-[https://git.corp.yahoo.com/pages/vespa/documentation/documentation/tutorials/blog-search.html](Vespa tutorial pt.1 - Blog searching)
+[Vespa tutorial pt.1 - Blog searching](https://git.corp.yahoo.com/pages/vespa/documentation/documentation/tutorials/blog-search.html)
for more information.
diff --git a/sample-apps/http-api-using-request-handlers-and-processors/README.md b/sample-apps/http-api-using-request-handlers-and-processors/README.md
index d72c6714545..7ca759a2ab5 100644
--- a/sample-apps/http-api-using-request-handlers-and-processors/README.md
+++ b/sample-apps/http-api-using-request-handlers-and-processors/README.md
@@ -1,6 +1,6 @@
# Vespa sample applications - Building a HTTP API using request handlers and processors
Please refer to
-[https://git.corp.yahoo.com/pages/vespa/documentation/documentation/jdisc/http-api-tutorial.html](building a HTTP API using request handlers and processors)
+[building a HTTP API using request handlers and processors](https://git.corp.yahoo.com/pages/vespa/documentation/documentation/jdisc/http-api-tutorial.html)
for more information.
diff --git a/sample-apps/http-api-using-searcher/README.md b/sample-apps/http-api-using-searcher/README.md
index a02fd3e27f6..3292d3050f5 100644
--- a/sample-apps/http-api-using-searcher/README.md
+++ b/sample-apps/http-api-using-searcher/README.md
@@ -1,7 +1,7 @@
# Vespa sample applications - Building a HTTP API using a searcher
Please refer to
-[https://git.corp.yahoo.com/pages/vespa/documentation/documentation/search/handler-tutorial.html](HTTP API use-case)
+[HTTP API use-case](https://git.corp.yahoo.com/pages/vespa/documentation/documentation/search/handler-tutorial.html)
for more information.