Skip to content

Commit

Permalink
chore(docs): Update docs for new Neovim config
Browse files Browse the repository at this point in the history
  • Loading branch information
Proveasio authored and Proveasio committed Aug 30, 2024
1 parent 7f0e506 commit e41bc4f
Show file tree
Hide file tree
Showing 11 changed files with 146 additions and 150 deletions.
2 changes: 1 addition & 1 deletion ansible/roles/config/files/tmux.conf
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ set-window-option -g window-status-current-format '#[fg=red,bg=default]( #[fg=wh
setw -g monitor-activity on
setw -g window-status-activity-style fg=yellow,bg=blue,bold

# Neovim/Lunarvim
# Neovim
set-option -sg escape-time 10
set-option -g focus-events on
set-option -sa terminal-overrides ',xterm-256color:RGB'
Expand Down
4 changes: 2 additions & 2 deletions docs-web/docs/main/customization/50-partial-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Above will run only configuration part of the automation, it won't install/updat
You can run multiple multiple tags at once:

```shell
ansible-playbook -i inventory.yml setup-ubuntu.yml --tags "neovim,lunarvim,tmux" -K
ansible-playbook -i inventory.yml setup-ubuntu.yml --tags "neovim,neovim-config,tmux" -K
```

:::
Expand Down Expand Up @@ -49,7 +49,7 @@ For particular functionality (`software` + `config`) below tags are available:
- kubectl
- lazygit
- lsg
- lunarvim
- neovim-config
- neovim
- nvm
- p10k
Expand Down
2 changes: 1 addition & 1 deletion docs-web/docs/main/features/10-terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ There are couple of useful plugins installed there (you can find them in `ansibl
- fuzzy search/go to directory
- aliases autosuggestions - tells you that you have an alias for particular commands
- easily traversing through **visited** directories (using [zoxide](https://github.com/ajeetdsouza/zoxide))
- ~correct your commands automatically with [thefuck](https://github.com/nvbn/thefuck)~
- (turned off temporarily) ~correct your commands automatically with [thefuck](https://github.com/nvbn/thefuck)~
- finding files with FZF
- Windows clipboard support - also works from VIM (copying in VIM makes it available in Windows clipboard)
2 changes: 0 additions & 2 deletions docs-web/docs/main/features/50-neovim.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,3 @@
It is set as default `EDITOR`, also aliased as `vim` (you can change it in `ansible/roles/config/templates/zshrc.j2`).

For details on how to navigate and power-use this IDE like a boss, see [Neovim usage](../../usage/vim)

Additionally, I setup the plugins below:
2 changes: 2 additions & 0 deletions docs-web/docs/main/features/60-other-software.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
- [yq](https://mikefarah.gitbook.io/yq/) - YAML parser
- [htop](https://github.com/htop-dev/htop) - better top
- [jq](https://stedolan.github.io/jq/) - JSON parser

And more...
13 changes: 4 additions & 9 deletions docs-web/docs/main/features/70-languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,12 @@ For usage examples see [Usage](../../usage/terminal#languages)

# Go

Automatic installation of Go is done using [`GVM`](https://github.com/moovweb/gvm) - Go Version Manager. By default `go1.20.4` gets installed (at the time of writing). See [Usage](../../usage/terminal#languages) for details.
Automatic installation of Go is done using [`GVM`](https://github.com/moovweb/gvm) - Go Version Manager. See [Usage](../../usage/terminal#languages) for details.

## Ruby

For Ruby management, there is [Ruby Version Manager (RVM)](https://rvm.io/) installed. See available Ruby's with `rvm list`, use particular with `rvm use <ruby_version>`. There are some gems already preinstalled on Rubys available here (like `neovim` gem, or if Puppet is being installed, it installs `puppet` and `puppet-lint` gems).

:::note
There might be some issues with installing/managing Ruby versions `< 3.1.x` on Ubuntu 22.04, but that might have been a random issue (to be confirmed)
:::

## JAVA/groovy

For multiple versions management for Java, groovy, gradle JDKs/SDKs, [SDKMAN!](https://sdkman.io/) manager is installed and some default JAVA and groovy versions.
Expand All @@ -42,11 +38,10 @@ By default, Puppet gets installed **for all rubies**. If you choose to install l

Ansible gets installed using PIP in designated `pyenv` Python environment. Also ansible-lint gets installed.

Also, there is an [Ansible Language Server](https://github.com/ansible/ansible-language-server) installed globally using default NPM, but LunarVIM uses it's own, auto-installed language server.
Also, there is an [Ansible Language Server](https://github.com/ansible/ansible-language-server) installed globally using default NPM.

To configure linter diagnostics (enable/disable some checks) in LunarVIM for Ansible files, see: `ansible/roles/config/files/ansible-lint`
To configure linter diagnostics (enable/disable some checks) for Ansible files, see: `ansible/roles/config/files/ansible-lint`

## Rust

As LunarVIM requires it, [Rust](https://www.rust-lang.org/) is installed with [Cargo](https://github.com/rust-lang/cargo/) package manager.

[Rust](https://www.rust-lang.org/) is installed with [Cargo](https://github.com/rust-lang/cargo/) package manager.
13 changes: 9 additions & 4 deletions docs-web/docs/main/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,14 @@ Assuming all the [requirements](./requirements) are met:
4. (from repo root) Run `sudo ./prepare-ubuntu.sh` (if not already run during windows setup) to update the system and install required python and ansible packages
5. Reload your terminal (close and open again)
6. (from repo root) Run ansible:
6. (from repo root) Run ansible:

```shell
cd ansible; ansible-playbook -i inventory.yml setup-ubuntu.yml -K
```
```shell
cd ansible; ansible-playbook -i inventory.yml setup-ubuntu.yml -K
```

7. After successful installation (green summary of versions installed), reload you terminal.

:::note
If either the preparation or installation steps are failing for you (#4 or #6), please see [Troubleshooting](./troubleshooting) section. If there is no answer for your problem, please create an Issue in Github.
:::
2 changes: 1 addition & 1 deletion docs-web/docs/main/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If using Windows with WSL2 Ubuntu also ensure:

- Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11
- WSL2 installed/enabled (version 0.67.6 and above)
- Ubuntu 22.04 installed
- Ubuntu 24.04 installed
- `systemd` enabled for installed Ubuntu distribution

:::note
Expand Down
6 changes: 3 additions & 3 deletions docs-web/docs/main/roles/10-software.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Various tools:
4. [Diff-so-fancy](https://github.com/so-fancy/diff-so-fancy) - alternate GIT DIFF presentation
5. [Git fuzzy](https://github.com/bigH/git-fuzzy.git) - managing GIT commands using FZF
6. [Gita](https://github.com/nosarthur/gita) - managing multiple GIT repositories at once (add groups, execute git or shell commands for those groups etc.)
7. ~[TheFuck](https://github.com/nvbn/thefuck) - corrects errors in previous console commands~
7. (temporarily disabled) ~[TheFuck](https://github.com/nvbn/thefuck) - corrects errors in previous console commands~
8. [BAT](https://github.com/sharkdp/bat) - (much) better CAT
9. [Zoxide](https://github.com/ajeetdsouza/zoxide) - traverse directories with ease (also with FZF)
10. [Helm](https://github.com/helm/helm) - Kubernetes 'package manager'
Expand All @@ -25,7 +25,7 @@ Various tools:
Development-related software:

1. [Neovim](https://github.com/neovim/neovim) - more handsome VIM brother
2. [LunarVIM](https://github.com/LunarVim/LunarVim) - Neovim IDE-like extension with awesome plugins/configurations included out of the box
2. [AstroNvim](https://astronvim.com/) - Neovim IDE-like extension with awesome plugins/configurations included out of the box
3. [RVM](https://rvm.io/) (Ruby enVironment Manager, installed using [rvm1-ansible-role](https://github.com/rvm/rvm1-ansible)), along with Ruby `3.1.3`
4. [PDK](https://puppet.com/try-puppet/puppet-development-kit/) (Puppet Development Kit)
5. [NVM](https://github.com/nvm-sh/nvm) (Node Version Manager) with latest LTS Node version (by default). Among all - dependency for LunarVIM installation
Expand Down Expand Up @@ -76,5 +76,5 @@ Available software excludes:
- rust
- ansible
- neovim
- lunarvim
- astronvim
- puppet
4 changes: 1 addition & 3 deletions docs-web/docs/main/roles/20-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ This role is mostly configs management. It will apply configuration for:
- thefuck (`~/.config/thefuck/settings.py`)
- LazyGIT (`~/.config/lazygit/config.yml`)
- ansible-lint (`~/.ansible-lint`)
- lunarvim (`~/.config/lvim/config.lua`)
- SDKMAN (`~/.sdkman/etc/config`)

If you want to exclude particular component configuration, you can add an array of sections, for example:
Expand All @@ -29,7 +28,7 @@ Available configs excludes:
- sdkman
- git
- lazygit
- lunarvim
- neovim-config
- thefuck
- ansible
Expand All @@ -40,4 +39,3 @@ By default, all configuration files are backed up in `~/.configs_backup` on ever
To disable taking backups, set:

`config_files_backup: false`

Loading

0 comments on commit e41bc4f

Please sign in to comment.