Add abra docs
continuous-integration/drone/push Build is passing Details

This commit is contained in:
decentral1se 2021-10-21 20:31:59 +02:00
parent 9c431c4f6d
commit fbfd2e2546
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
2 changed files with 37 additions and 2 deletions

34
docs/abra.md Normal file
View File

@ -0,0 +1,34 @@
---
title: Abra
---
## Enable auto-completion
### Bash
Copy `scripts/autocomplete/bash` into `/etc/bash_completion.d/` and rename
it to abra.
```
sudo cp scripts/autocomplete/bash /etc/bash_completion.d/abra
source /etc/bash_completion.d/abra
```
In development, you can source the script in your git checkout, just make sure
to set `PROG=abra`, otherwise it'll add completion to the wrong command:
```
PROG=abra source /path/to/abra/scripts/autocomplete/bash
```
### (Fi)Zsh
(fi)zsh doesn't have an autocompletion folder by default but you can create one, then copy `scripts/autocomplete/zsh` into it and add a couple lines to your `~/.zshrc` or `~/.fizsh/.fizshrc`
```
sudo mkdir /etc/zsh/completion.d/
sudo cp scripts/autocomplete/zsh /etc/zsh/completion.d/abra
echo "PROG=abra\n_CLI_ZSH_AUTOCOMPLETE_HACK=1\nsource /etc/zsh/completion.d/abra" >> ~/.zshrc
```
(replace .zshrc with ~/.fizsh/.fizshrc if you use fizsh)

View File

@ -14,7 +14,7 @@ theme:
logo: img/favicon.ico
favicon: img/favicon.ico
copyright: Copyleft 🄯 2021 The Co-operative Cloud
copyright: Copyleft 🄯 2021 Co-op Cloud
markdown_extensions:
- meta
@ -33,13 +33,14 @@ markdown_extensions:
emoji_generator: !!python/name:materialx.emoji.to_svg
nav:
- "A co-operative alternative 🥳": index.md
- "Introduction": index.md
- Getting started guide:
- Architecture overview: overview.md
- Deploy your first app: deploy.md
- App catalogue: apps.md
- App config guide: app-config-guide.md
- Recipe maintainer guide: recipe-maintainer-guide.md
- Abra guide: abra.md
- Frequently asked questions: faq.md
- Contributing guide: contribute.md
- Community organising: comm-org.md