khuedoan-homelab/docs/getting-started/user-onboarding.md
Khue Doan 1405fadf1a refactor(docs): apply the Diátaxis framework
Squashed commit of the following:

commit 257867f196376df55fa0f57edbdf33967b1da04e
Author: Khue Doan <mail@khuedoan.com>
Date:   Sun Sep 18 16:45:42 2022 +0700

    refactor(docs): apply the Diátaxis framework
2022-09-19 02:40:07 +07:00

47 lines
1.3 KiB
Markdown

# User onboarding
=== "For user"
## Create user
Ask an admin to create your account, provide the following information:
- [ ] Full name (John Doe)
- [ ] Select a username (`johndoe`)
- [ ] Email address (`johndoe@example.com`)
## Install companion apps
For all users:
- [ ] [Password manager](#recommended-password-managers)
- [ ] [Matrix chat client](https://matrix.org/clients) (optional, you can use the web version)
For technical users:
- [ ] [Docker](https://docs.docker.com/engine/install)
- [ ] [Lens](https://k8slens.dev) (optional, you can use the included `kubectl` or `k9s` command in the tools container)
=== "For admin"
## Create a new account
TODO
## Send initial password
Choose one of the methods listed below to send the initial password to the user:
- Share via password manager (if supported)
- Encrypt the password file and send it via email or chat
- Simply write or print the password on a piece of paper
On the first login, the user will be required to update their password.
## Appendix
### Recommended password managers
- [Bitwarden](https://bitwarden.com/download) (easy to use, but requires an online account)
- [KeePassXC](https://keepassxc.org) (completely offline, but you'll need to sync manually)