[Docs] language server pages #1490

predragnikolic · 2020-11-24T21:35:52Z

added:

suggestion for installing LSP-json
added instructions for installing plugins like LSP-angular, LSP-graphql and other plugins that were missing.
discord icon in the footer
ST4 and ST3 Client Configuration tabs

changed:

point to LSP-* instantiation instructions instead of manual configuration
renamed "Server Configuration" to "Client Configuration"

removed:

removed deprecated sourcegraph's go-language server (in favour of gopls)
remove polymer editor service
remove intellij configuration option (in favour of Eclipse JDT Language Server)
remove microsoft's python language server option (in favour of pyright and pyls)
removed lua-lsp reference (in favour of lua-ls client configuration)
removed SBT, DOTTY scala config references (in favour of LSP-metals)

Should I bring any of the removed configurations back?

I think the best way to see the difference is to start the development server locally, and compare it to the current site https://sublimelsp.github.io/LSP/language_servers/

Note: I noticed that some links are broken (for example the C/C++ guide link). That is due to the /lsp prefix that gh pages adds for repos. I added site_url: https://sublimelsp.github.io/LSP/ to the mkdocs.yaml file, but I am not sure if that is gonna fix it.

Maybe I will have to include the lsp prefix in the links:

- [C/C++ guide](/guides/cplusplus)
+ [C/C++ guide](/lsp/guides/cplusplus)

If you know a solution for the link problem, please let me know :)

As they are not necessary, because the MkDocs theme is configured to generate the hash links automatically

…gin available

They moved the repo to https://github.com/Polymer/tools/tree/master/packages/editor-service but they haven't updated the since on 9 Jul 2019, they also have a vs code plugin which also havent seen an update. So I will consider this repo unmaintained and will remove the configuration.

not sure if the setting tcp_port even works. Feel free to discuss this if you want me to revert this removal.

…vers When we publish the plugins we will add them to the docs

As the LaTeX plugin is only available on ST 4

for consistency

jwortmann · 2020-11-24T22:21:38Z

Looks like all relative links are broken. Could you try

- [list of language servers](/language_servers/)
+ [list of language servers](language_servers.md)

in index.md and

- [C/C++ guide](/guides/cplusplus)
+ [C/C++ guide](guides/cplusplus.md)

https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages

predragnikolic · 2020-11-24T22:29:46Z

Thanks @jwortmann :)

rchl · 2020-11-27T21:49:57Z

Would it make sense and work for mkdocs.yml to live in the docs folder?

docs/language_servers.md

predragnikolic · 2020-11-27T22:57:41Z

@rchl It makes sense that docs related files are in the docs folder,
so looked up on how to move the mkdocs file and I stumbled upon this:

mkdocs/mkdocs#1276

I am not that bothered with the mkdocs.yml file being at the root.
But If you are, there is one solution suggested by one of the maintainers of mkdocs:
mkdocs/mkdocs#1276 (comment) (the docs/src solution seems ok)

rchl · 2020-11-28T12:39:49Z

@rchl It makes sense that docs related files are in the docs folder,
so looked up on how to move the mkdocs file and I stumbled upon this:

mkdocs/mkdocs#1276

I am not that bothered with the mkdocs.yml file being at the root.
But If you are, there is one solution suggested by one of the maintainers of mkdocs:
mkdocs/mkdocs#1276 (comment) (the docs/src solution seems ok)

From that comment it seems possible if we create /docs/src/ directory and put mkdocs.yml in /docs/. I don't want to make the call though. We'll see what @rwols has to say.

BTW. The /site/ directory should be git-ignored.

EDIT: Sorry for repeating what you've said but I didn't read your comment thoroughly :)

rwols · 2020-11-28T13:02:49Z

Putting things in docs/src sounds good to me!

for consistency

docs/site folder is generated when `mkdocs build` command is run

rwols

Looks good to me :)

predrag-codetribe added 24 commits November 21, 2020 23:09

add tip that suggest installing LSP-json

d057d27

remove a links next to titles

bdbce03

As they are not necessary, because the MkDocs theme is configured to generate the hash links automatically

use header 2 level for language titles

2b5ea06

add missing configuration

a78663a

point to LSP-* plugins instead of manual configuration when LSP-* plu…

a164c28

…gin available

make manual configuration more consistent WIP

abb8e16

remove deprecated go server

601d60e

make manual configuration more consistent WIP

65b6e68

remove intellij configuration option

981cac1

not sure if the setting tcp_port even works. Feel free to discuss this if you want me to revert this removal.

remove not published plguins in favor of manually configuring the ser…

048d01c

…vers When we publish the plugins we will add them to the docs

add discord icon and add the site_url

15bc508

add ST3 and ST4 client configuration

ece8781

rename ""server configuration" to "client configuration"

ed9eea8

reorder attributes for consistency

5f1226a

update url and remove unnecessary newlines

ac8451a

change wording

3216ac2

add sentence that there are multiple options

34feb15

add . in tooltips for consistency

fb3898e

fix repo link

a71661a

add plugin and manual configuration instructions fror LaTeX

d3ed351

As the LaTeX plugin is only available on ST 4

be more precise how to open settings

8bde237

add missing step for installing Terraform syntax

7cdcdf2

change wording

ae619b7

predragnikolic added the documentation label Nov 24, 2020

remove trailing comma

5853f06

for consistency

use relative path for linking pages

693d25b

predragnikolic marked this pull request as draft November 24, 2020 23:38

ottob mentioned this pull request Nov 27, 2020

Mention experimental multi module gopls option #1492

Closed

rchl reviewed Nov 27, 2020

View reviewed changes

docs/language_servers.md Outdated Show resolved Hide resolved

fix link to client configuration

bcfb6b4

predragnikolic added 3 commits November 28, 2020 22:27

use json language id

f9f4a88

for consistency

move documentation to docs/src

0c34ec6

ignore docs/site folder

9b034f6

docs/site folder is generated when `mkdocs build` command is run

rwols changed the title ~~Docs/langauge servers page~~ [Docs] language server pages Dec 1, 2020

predragnikolic added 2 commits December 3, 2020 00:59

move README from docs/src to /docs

3eb6a2b

mention go experimentalWorkspaceModule setting

f7fb37e

predragnikolic marked this pull request as ready for review December 3, 2020 00:22

use words "client configuration" instead of just "configuration"

c172033

rwols approved these changes Dec 3, 2020

View reviewed changes

predragnikolic merged commit a98e004 into st4000-exploration Dec 3, 2020

predragnikolic deleted the docs/langauge-servers-page branch December 3, 2020 21:34

rwols mentioned this pull request Dec 30, 2020

Hint about gopls multi-module workspace support #1471

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Docs] language server pages #1490

[Docs] language server pages #1490

predragnikolic commented Nov 24, 2020 •

edited

Loading

jwortmann commented Nov 24, 2020

predragnikolic commented Nov 24, 2020

rchl commented Nov 27, 2020

predragnikolic commented Nov 27, 2020

rchl commented Nov 28, 2020 •

edited

Loading

rwols commented Nov 28, 2020

rwols left a comment

[Docs] language server pages #1490

[Docs] language server pages #1490

Conversation

predragnikolic commented Nov 24, 2020 • edited Loading

jwortmann commented Nov 24, 2020

predragnikolic commented Nov 24, 2020

rchl commented Nov 27, 2020

predragnikolic commented Nov 27, 2020

rchl commented Nov 28, 2020 • edited Loading

rwols commented Nov 28, 2020

rwols left a comment

Choose a reason for hiding this comment

predragnikolic commented Nov 24, 2020 •

edited

Loading

rchl commented Nov 28, 2020 •

edited

Loading