wiki: Users says what differs over stock ssh, and where the wiki lives !336
1 file changed, +18 −10
Layout: unified · split
.gitbay/wiki/Users.org +18 −10
| @@ -1,9 +1,17 @@ | |||
| 1 | #+title: gitbay user guide | 1 | #+title: gitbay user guide |
| 2 | 2 | ||
| 3 | Everything here works from stock OpenSSH — replace =gitbay= with | 3 | Everything here works from stock OpenSSH — replace =gitbay= with |
| 4 | =ssh git@<host>= in any command and it behaves identically. The CLI adds | 4 | =ssh git@<host>= in any command. The CLI adds convenience (instance |
| 5 | convenience (instance profiles, repo inference, =$EDITOR=), nothing more. | 5 | profiles, repo inference, =$EDITOR=), nothing more. Two things differ |
| 6 | =ssh git@<host> help= lists every command the server knows. | 6 | over bare ssh: |
| 7 | |||
| 8 | - ssh joins its arguments with spaces and the server tokenizes the | ||
| 9 | result, so a value with a space in it needs a second layer of quotes: | ||
| 10 | =--description "'a widget'"=, not =--description "a widget"=, which | ||
| 11 | arrives as two arguments. | ||
| 12 | - =--help= is not understood. =ssh git@<host> help= lists every command | ||
| 13 | the server knows, and =help <noun>= (=help repo=, =help mr=) prints | ||
| 14 | the usage of each command under that noun. | ||
| 7 | 15 | ||
| 8 | * Installing the CLI | 16 | * Installing the CLI |
| 9 | 17 | ||
| @@ -285,17 +293,17 @@ that is why no =owner/name= appears above. Anywhere else, pass it as the | |||
| 285 | first argument. Long text: =--body= inline, =--file -= from stdin, or | 293 | first argument. Long text: =--body= inline, =--file -= from stdin, or |
| 286 | neither on a terminal and =$EDITOR= opens. | 294 | neither on a terminal and =$EDITOR= opens. |
| 287 | 295 | ||
| 288 | Wikis are companion repositories edited by push — no separate storage, | 296 | A wiki is the =.gitbay/wiki/= directory on the default branch — no |
| 289 | no web editor, the same rendering pipeline as READMEs (markdown and | 297 | separate repository, the same rendering pipeline as READMEs (markdown |
| 290 | org). Access mirrors the parent repo (read to view, write to push); | 298 | and org). Editing it is editing a file: a push, =repo commit-file=, or |
| 291 | the companion is created on your first push and follows the repo | 299 | the web editor on a repository that permits server-authored commits (one |
| 292 | through transfer and delete: | 300 | requiring signed commits is push-only, since the server signs nothing): |
| 293 | 301 | ||
| 294 | #+begin_src sh | 302 | #+begin_src sh |
| 295 | git clone ssh://git@<host>/you/project.wiki.git | 303 | mkdir -p .gitbay/wiki |
| 296 | # add Home.md (or .org), more pages, images; relative links between | 304 | # add Home.md (or .org), more pages, images; relative links between |
| 297 | # pages just work on the web at /you/project/wiki | 305 | # pages just work on the web at /you/project/wiki |
| 298 | git push | 306 | git add .gitbay/wiki && git commit -m "wiki" && git push |
| 299 | #+end_src | 307 | #+end_src |
| 300 | 308 | ||
| 301 | Releases anchor notes and binary assets to a pushed tag (write access; | 309 | Releases anchor notes and binary assets to a pushed tag (write access; |