Merge branch 'main' into feat/diag-annotations

* main: Docs: Add LSP-clangd and LSP-terraform to Language Servers (#2096)
sublimelsp · Oct 23, 2022 · e0e41c8 · e0e41c8
2 parents f9f1c50 + 5fdcbf6
commit e0e41c8
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 138 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -14,7 +14,7 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material
+      - run: pip install mkdocs-material mkdocs-redirects
       - run: |
           cd docs
           mkdocs gh-deploy --force
diff --git a/docs/README.md b/docs/README.md
@@ -1,18 +1,18 @@
 # Welcome to MkDocs
 
-Install MkDocs - https://www.mkdocs.org/#installing-mkdocs
+Install:
+ - MkDocs - https://www.mkdocs.org/#installing-mkdocs
+ - Material Theme - https://squidfunk.github.io/mkdocs-material/getting-started/#installation
+ - mkdocs-redirects - https://github.com/mkdocs/mkdocs-redirects
 
-Install Material Theme - https://squidfunk.github.io/mkdocs-material/getting-started/#installation
-
-```
-pip install mkdocs mkdocs-material
+```sh
+pip install mkdocs mkdocs-material mkdocs-redirects
 ```
 
 For full documentation visit [mkdocs.org](https://www.mkdocs.org).
 
 ## Commands
 
-* `mkdocs new [dir-name]` - Create a new project.
 * `mkdocs serve` - Start the live-reloading docs server.
 * `mkdocs build` - Build the documentation site.
 * `mkdocs -h` - Print help message and exit.

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -4,6 +4,13 @@ repo_url: https://github.com/sublimelsp/LSP/
 edit_uri: edit/main/docs/src/
 docs_dir: 'src'
 
+plugins:
+  - search
+  - redirects:
+      redirect_maps:
+        'guides/cplusplus.md': 'https://github.com/sublimelsp/LSP-clangd'
+        'guides/client_configuration.md': 'client_configuration.md'
+
 theme:
   name: material
   palette:
@@ -37,14 +44,12 @@ markdown_extensions:
 
 nav:
     - Getting Started: index.md
-    - Features: features.md
     - Language Servers: language_servers.md
+    - Features: features.md
     - Commands: commands.md
     - Keyboard Shortcuts: keyboard_shortcuts.md
     - Customization: customization.md
-    - Guides:
-      - Client Configuration: guides/client_configuration.md
-      - Setup C/C++: guides/cplusplus.md
+    - Client Configuration: client_configuration.md
     - Troubleshooting: troubleshooting.md
 
 extra:

diff --git a/docs/src/guides/client_configuration.md → docs/src/client_configuration.md b/docs/src/guides/client_configuration.md → docs/src/client_configuration.md
diff --git a/docs/src/guides/cplusplus.md b/docs/src/guides/cplusplus.md
diff --git a/docs/src/language_servers.md b/docs/src/language_servers.md
@@ -28,7 +28,7 @@ Follow installation instructions on [LSP-Bicep](https://github.com/sublimelsp/LS
 
 ## C/C++
 
-See the dedicated [C/C++ guide](guides/cplusplus.md) for using ccls or clangd.
+Follow installation instructions on [LSP-clangd](https://github.com/sublimelsp/LSP-clangd).
 
 ## C\#
 
@@ -555,37 +555,7 @@ Follow installation instructions on [LSP-tailwindcss](https://github.com/sublime
 
 ## Terraform
 
-1. Install the [Terraform](https://packagecontrol.io/packages/Terraform) package from Package Control for syntax highlighting.
-2. Install [terraform-ls](https://github.com/hashicorp/terraform-ls) or [terraform-lsp](https://github.com/juliosueiras/terraform-lsp).
-3. Open `Preferences > Package Settings > LSP > Settings` and add the `"terraform"` client configuration to the `"clients"`:
-
-    For `terraform-ls`:
-
-    ```json
-    {
-        "clients": {
-            "terraform": {
-                "enabled": true,
-                "command": ["terraform-ls", "serve"],
-                "selector": "source.terraform"
-            }
-        }
-    }
-    ```
-
-    For `terraform-lsp`:
-
-    ```json
-    {
-        "clients": {
-            "terraform": {
-                "enabled": true,
-                "command": ["terraform-lsp"],
-                "selector": "source.terraform"
-            }
-        }
-    }
-    ```
+Follow installation instructions on [LSP-terraform](https://github.com/sublimelsp/LSP-terraform).
 
 ## Vue