Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quickstart tutorial #5

Merged
merged 8 commits into from
Jan 20, 2021

Conversation

Purvanshsingh
Copy link
Member

I have tried to make the Quickstart section of the Documentation, Containing the setup of the Hydrus server using docker-compose.

@raoashish10
Copy link

Just a suggestion, I think you can change http://localhost:8080/api/vocab#Drone to http://localhost:8080/api/vocab because #Drone is supposed to be specific to the Drone class only even though it returns the whole vocab at the moment.

@Purvanshsingh
Copy link
Member Author

Just a suggestion, I think you can change http://localhost:8080/api/vocab#Drone to http://localhost:8080/api/vocab because #Drone is supposed to be specific to the Drone class only even though it returns the whole vocab at the moment.

yes, that's a typo thanks will fix it.

Copy link
Member

@priyanshunayan priyanshunayan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for volunteering! It was easy to follow along with this tutorial, and that is really helpful. I have hinted at some changes and one additional point: A quickstart for an agent too, maybe?

@@ -4,4 +4,35 @@ 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users don't need to know the best practices to follow this document, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you are right my intention was to just make people familiar with docker many of them may not aware of docker-compose.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please give links to the official installation guide as well.

docs/src/content/quickstart.md Show resolved Hide resolved
docs/src/content/quickstart.md Outdated Show resolved Hide resolved
## Running hydrus server
> Make sure you have docker-compose installed in your system

#### Getting the [hydrus repository](https://github.com/HTTP-APIs/hydrus)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please maintain a consistent heading hierarchy. If a heading is inside h1, it should be h2. if it is inside h2, it should be h3, not h4. Inconsistent hierarchy might break the inpage navigation.

```bash
git clone https://github.com/HTTP-APIs/hydrus
```
#### Change directory and run docker-compose
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having the steps as headings give the impression that there might be some sub-steps as well. I think having an ordered list for the steps can be a good thing. Did you have any special reason to list them as headings?

@chrizandr
Copy link
Member

@priyanshunayan merge these commits to a separate branch without review, like we have for the other pages, we can directly edit on the branch then before merging to main. It is difficult to make edits here because we don't have access to Purvansh's fork. Any changes from outside can be made as PRs to the branch.

@priyanshunayan priyanshunayan changed the base branch from main to quickstart January 20, 2021 11:43
@priyanshunayan priyanshunayan merged commit d760adb into HTTP-APIs:quickstart Jan 20, 2021
@chrizandr chrizandr mentioned this pull request Jan 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants