wip

Author: vlad-ivanov-name

README.md

@@ -6,20 +6,24 @@ blazingly-fast, incremental, and reversible implementation of git history filter
 `josh-proxy` can be integrated with any git host:
 
 ```
-$ docker run -p 8000:8000 -e JOSH_REMOTE=https://github.com -v josh-vol:/data/git joshproject/josh-proxy:latest
+$ docker run \
+    -p 8000:8000 \
+    -e JOSH_REMOTE=https://github.com \
+    -v josh-vol:/data/git \
+    joshproject/josh-proxy:latest
 ```
 
 See [Container options](#container-options) for full list of environment variables.
 
 ## Use cases
 
-### Partial cloning
+### Partial cloning <a href="https://josh-project.dev/~/ui/browse?repo=josh.git&path=&filter=%3A%2Fdocs&rev=HEAD"><img src="https://img.shields.io/badge/try_it-josh--project.dev-black"/></a>
 
 Reduce scope and size of clones by treating subdirectories of the monorepo
 as individual repositories.
 
 ```
-$ git clone http://josh/monorepo.git:/path/to/library.git
+$ git clone https://josh-project.dev/josh.git:/docs.git
 ```
 
 The partial repo will act as a normal git repository but only contain the files

docs/src/guide/gettingstarted.md

@@ -10,35 +10,35 @@ proxy to serve your own git repository.
 
 ## Setting up the proxy
 
-Josh is distributed via [docker hub](https://hub.docker.com/r/joshproject/josh-proxy),
+Josh is distributed via [Docker Hub](https://hub.docker.com/r/joshproject/josh-proxy),
 and is installed and started with the following command:
 
 ```shell
 {{#include gettingstarted.t:docker_github}}
 ```
 
-This starts josh as a proxy to github.com, in a docker container, 
-mounting the ./git\_data folder to the image for use by josh.
+This starts Josh as a proxy to `github.com`, in a Docker container, 
+creating a volume `josh-vol` and mounting it to the image for use by Josh.
 
 ## Cloning a repository
 
-Once josh is running, we can clone a repository through it.
-For example, let's clone josh:
+Once Josh is running, we can clone a repository through it.
+For example, let's clone Josh:
 
 ```shell
 {{#include gettingstarted.t:clone_full}}
 ```
 
-As we can see, this repository is simply the normal josh one:
+As we can see, this repository is simply the normal Josh one:
 
 ```shell
 {{#include gettingstarted.t:ls_full}}
 ```
 
-## Extracting a module
+## Cloning a part of the repo
 
-Josh becomes interesting when we want to extract a module.
-Let's check out the josh repository again, but this time let's filter
+Josh becomes interesting when we want to clone a part of the repo.
+Let's check out the Josh repository again, but this time let's filter
 only the documentation out:
 
 ```shell

docs/src/guide/gettingstarted.t

@@ -1,9 +1,13 @@
   $ export TESTTMP=${PWD}
-  $ mkdir git_data
 
 # starting josh
 ANCHOR: docker_github
-  $ docker run -d -p 8000:8000 -e JOSH_REMOTE=https://github.com -v josh-vol:$(pwd)/git_data joshproject/josh-proxy:latest > josh.out
+  $ docker run \
+  >   --detach \
+  >   --publish 8000:8000 \
+  >   --env JOSH_REMOTE=https://github.com \
+  >   --volume josh-vol:/data/git \
+  >   joshproject/josh-proxy:latest > josh.out
 ANCHOR_END: docker_github
 
 # waiting for josh to be running