Quickstart to run docsy-example locally using a Docker container #387
Conversation
|
|
||
| 1. [Install git](https://github.com/git-guides/install-git). | ||
|
|
||
| ## Clone the docsy-example repository |
There was a problem hiding this comment.
Given that we now have a template repository, should we tell them to use it as a template and then clone it? If they just clone our repo they still need to create something in GitHub to push their updates to (and change the origin remote, otherwise they'll end up trying to push to docsy-example). Or we can just link to the "don't forget to create a repo to push to" bit from the regular docs afterwards.... What do you think?
| git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git | ||
| ``` | ||
|
|
||
| 1. Change your working directory to the newly crated folder: |
| @@ -0,0 +1,89 @@ | |||
|
|
|||
| --- | |||
| title: "Quickstart" | |||
There was a problem hiding this comment.
I think as it is, this is slightly confusing - we have "Quickstart" and "Getting started" as sort of peer pages and it's not clear which one you should go to first (I also have a personal dislike of the term Quickstart but I can live with it. :) ). We also should make it clear that you can use the Docker image as a real environment for working locally on your own sites, not just as a "kick the tyres with the example site" tool for a tutorial.
How about we move this under /getting_started/ and rename it "Quickstart with Docker" (so it'll show up as a sub-page in the nav)
I would also in the main Getting started add a new section under Prerequisites and installation (right at the top so users who don't want to have to install anything can see it) - something like
Use our Docker image
We provide a Docker image that you can use to run and test your Docsy site locally, without having to install all Docsy's dependencies.
You can see how to get started with this approach by following our Quickstart tutorial (linky). If you don't want to use Docker, follow the instructions below to install Hugo and PostCSS.
There was a problem hiding this comment.
I like your suggestions. I just reviewed the docker-compose PR and suggested a couple of changes, as soon as we get that merged I will update this PR.
There was a problem hiding this comment.
Would be great to get this in now that the Docker update is merged! subtle hint face
There was a problem hiding this comment.
Currently working on it :)
|
Updated installation instructions with the requested changes. |
|
This is great! I fixed a few nits directly, so it's good to go! |
Added a quickstart to get new users up and running in just a few minutes. This PR is contingent on google/docsy-example#75 being merged.