From 20749b8bd97dbe22ab93484c2df6f12708c37963 Mon Sep 17 00:00:00 2001 From: Purvansh Singh Date: Mon, 18 Jan 2021 09:04:27 +0530 Subject: [PATCH 1/8] Created Quickstart Guide. --- docs/src/content/quickstart.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/src/content/quickstart.md b/docs/src/content/quickstart.md index 5852a83..f8e467f 100644 --- a/docs/src/content/quickstart.md +++ b/docs/src/content/quickstart.md @@ -4,4 +4,27 @@ name: Quickstart # Quickstart Guide -This will lead you to different paths. +This Quickstart tutorial will guide you to setup the Hydrus server, we will be using docker in this tutorial, +Therefore you can go through the [Docker container engine](https://docker-curriculum.com/) and its best practices deploying virtualized environments. + +## Running hydrus server +> Make sure you have docker-compose installed in your system +> ```bash +> docker-compose -v + +### Getting the [hydrus repository](https://github.com/HTTP-APIs/hydrus) +```bash +git clone https://github.com/HTTP-APIs/hydrus +``` +### Change directory and run docker-compose +```bash +cd hydrus + +docker-compose up --build +``` +> If you are using lunix you may have to use sudo command with docker + +### Hydrus demo server is up and running at +```bash +http://localhost:8080/api/vocab#Drone +``` From 65937673312afc3cedb5107f6ce5f9cc61ca6a1d Mon Sep 17 00:00:00 2001 From: Purvansh Singh <49719371+Purvanshsingh@users.noreply.github.com> Date: Mon, 18 Jan 2021 10:40:24 +0530 Subject: [PATCH 2/8] typo fixed --- docs/src/content/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/content/quickstart.md b/docs/src/content/quickstart.md index f8e467f..1dc0d49 100644 --- a/docs/src/content/quickstart.md +++ b/docs/src/content/quickstart.md @@ -22,7 +22,7 @@ cd hydrus docker-compose up --build ``` -> If you are using lunix you may have to use sudo command with docker +> If you are using linux you may have to use sudo command with docker ### Hydrus demo server is up and running at ```bash From b03723c76c3feead6b410a443d3d5b79e9d9332e Mon Sep 17 00:00:00 2001 From: Purvansh Singh Date: Mon, 18 Jan 2021 12:23:04 +0530 Subject: [PATCH 3/8] update quickstart.md --- docs/src/content/quickstart.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/src/content/quickstart.md b/docs/src/content/quickstart.md index 1dc0d49..36908fe 100644 --- a/docs/src/content/quickstart.md +++ b/docs/src/content/quickstart.md @@ -9,8 +9,6 @@ Therefore you can go through the [Docker container engine](https://docker-curric ## Running hydrus server > Make sure you have docker-compose installed in your system -> ```bash -> docker-compose -v ### Getting the [hydrus repository](https://github.com/HTTP-APIs/hydrus) ```bash From 2fd7e2e48036be708293c65ed4b15499c1533bb9 Mon Sep 17 00:00:00 2001 From: Purvansh Singh Date: Mon, 18 Jan 2021 12:44:14 +0530 Subject: [PATCH 4/8] Custom API Documentation section added. --- docs/src/content/quickstart.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/src/content/quickstart.md b/docs/src/content/quickstart.md index 36908fe..488cd17 100644 --- a/docs/src/content/quickstart.md +++ b/docs/src/content/quickstart.md @@ -24,5 +24,15 @@ docker-compose up --build ### Hydrus demo server is up and running at ```bash -http://localhost:8080/api/vocab#Drone +http://localhost:8080/api/vocab ``` + +### Adding your own Hydra Documentation + +You can serve your own Hydra API documentation: + +* create a `doc.py` file as the ones in `examples/` directory containing your own ApiDoc +* set the `APIDOC_REL_PATH` variable in `docker-compose.yml`. This should the relative path from the project root +start-up the demo as above. + +Your API Documentation will be served by the hydrus server. \ No newline at end of file From 7059f67224086ab18683387045bb88ddf6881bde Mon Sep 17 00:00:00 2001 From: Purvansh Singh Date: Mon, 18 Jan 2021 13:05:12 +0530 Subject: [PATCH 5/8] Font size fix --- docs/src/content/quickstart.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/src/content/quickstart.md b/docs/src/content/quickstart.md index 488cd17..e89357c 100644 --- a/docs/src/content/quickstart.md +++ b/docs/src/content/quickstart.md @@ -10,11 +10,11 @@ Therefore you can go through the [Docker container engine](https://docker-curric ## Running hydrus server > Make sure you have docker-compose installed in your system -### Getting the [hydrus repository](https://github.com/HTTP-APIs/hydrus) +#### Getting the [hydrus repository](https://github.com/HTTP-APIs/hydrus) ```bash git clone https://github.com/HTTP-APIs/hydrus ``` -### Change directory and run docker-compose +#### Change directory and run docker-compose ```bash cd hydrus @@ -22,12 +22,12 @@ docker-compose up --build ``` > If you are using linux you may have to use sudo command with docker -### Hydrus demo server is up and running at +#### Hydrus demo server is up and running at ```bash http://localhost:8080/api/vocab ``` -### Adding your own Hydra Documentation +## Adding your own Hydra Documentation You can serve your own Hydra API documentation: From ef328e07880d87caffa4fd87c5a21f807a096d56 Mon Sep 17 00:00:00 2001 From: Purvansh Singh Date: Mon, 18 Jan 2021 17:40:10 +0530 Subject: [PATCH 6/8] custom API Doc removed. --- docs/src/content/quickstart.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/docs/src/content/quickstart.md b/docs/src/content/quickstart.md index e89357c..da6180b 100644 --- a/docs/src/content/quickstart.md +++ b/docs/src/content/quickstart.md @@ -25,14 +25,4 @@ docker-compose up --build #### Hydrus demo server is up and running at ```bash http://localhost:8080/api/vocab -``` - -## Adding your own Hydra Documentation - -You can serve your own Hydra API documentation: - -* create a `doc.py` file as the ones in `examples/` directory containing your own ApiDoc -* set the `APIDOC_REL_PATH` variable in `docker-compose.yml`. This should the relative path from the project root -start-up the demo as above. - -Your API Documentation will be served by the hydrus server. \ No newline at end of file +``` \ No newline at end of file From dc169834b79982bd77d6c7cadd2106ed237011d3 Mon Sep 17 00:00:00 2001 From: Purvansh Singh Date: Mon, 18 Jan 2021 18:03:20 +0530 Subject: [PATCH 7/8] Added required changes. --- docs/src/content/quickstart.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/src/content/quickstart.md b/docs/src/content/quickstart.md index da6180b..157e3a1 100644 --- a/docs/src/content/quickstart.md +++ b/docs/src/content/quickstart.md @@ -5,16 +5,18 @@ name: Quickstart # Quickstart Guide This Quickstart tutorial will guide you to setup the Hydrus server, we will be using docker in this tutorial, -Therefore you can go through the [Docker container engine](https://docker-curriculum.com/) and its best practices deploying virtualized environments. +Therefore you can go through the [Docker container engine](https://docker-curriculum.com/). +## Requirements +* Install [git](https://git-scm.com/downloads) +* Make sure you have [docker-compose](https://docs.docker.com/compose/install/) installed in your system ## Running hydrus server -> Make sure you have docker-compose installed in your system -#### Getting the [hydrus repository](https://github.com/HTTP-APIs/hydrus) +1. Getting the [hydrus repository](https://github.com/HTTP-APIs/hydrus) ```bash git clone https://github.com/HTTP-APIs/hydrus ``` -#### Change directory and run docker-compose +2. Change directory and run docker-compose ```bash cd hydrus @@ -22,7 +24,7 @@ docker-compose up --build ``` > If you are using linux you may have to use sudo command with docker -#### Hydrus demo server is up and running at +3. Hydrus demo server is up and running at ```bash http://localhost:8080/api/vocab ``` \ No newline at end of file From df6201d9b33ac9d4d3cd5f8fdfc8db1df25cc82a Mon Sep 17 00:00:00 2001 From: Purvansh Singh Date: Tue, 19 Jan 2021 14:15:28 +0530 Subject: [PATCH 8/8] typo fixed. --- docs/src/content/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/content/quickstart.md b/docs/src/content/quickstart.md index 157e3a1..da78a6c 100644 --- a/docs/src/content/quickstart.md +++ b/docs/src/content/quickstart.md @@ -14,7 +14,7 @@ Therefore you can go through the [Docker container engine](https://docker-curric 1. Getting the [hydrus repository](https://github.com/HTTP-APIs/hydrus) ```bash -git clone https://github.com/HTTP-APIs/hydrus +git clone https://github.com/HTTP-APIs/hydrus.git ``` 2. Change directory and run docker-compose ```bash