Quickstart tutorial #5
Conversation
|
Just a suggestion, I think you can change |
yes, that's a typo thanks will fix it. |
docs/src/content/quickstart.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
Users don't need to know the best practices to follow this document, right?
There was a problem hiding this comment.
Yes, you are right my intention was to just make people familiar with docker many of them may not aware of docker-compose.
docs/src/content/quickstart.md
Outdated
| 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 |
There was a problem hiding this comment.
please give links to the official installation guide as well.
docs/src/content/quickstart.md
Outdated
| ## Running hydrus server | ||
| > Make sure you have docker-compose installed in your system | ||
|
|
||
| #### Getting the [hydrus repository](https://github.com/HTTP-APIs/hydrus) |
There was a problem hiding this comment.
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.
docs/src/content/quickstart.md
Outdated
| ```bash | ||
| git clone https://github.com/HTTP-APIs/hydrus | ||
| ``` | ||
| #### Change directory and run docker-compose |
There was a problem hiding this comment.
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?
|
@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. |
I have tried to make the Quickstart section of the Documentation, Containing the setup of the Hydrus server using docker-compose.