Update documentation for Go language server deployment #244
Conversation
This commit changes the documentation for the Go language server deployment to make it clearer that, you can try out the Go language server support... 1. ... without having to setup TLS/SSL (even though we recommend it!) 2. ... without having to use HTTP basic authentication (even though we recommend it!) In order to that, I did three things: 1. add a suffix to the two sections so it's clear you can skip the "Setup TLS/SSL" and "HTTP Basic authentication" section 2. extract the updating of the global settings into a separate step so readers won't miss it when they skip HTTP basic auth 3. extend the section about global settings to explain what to do when the first two sections were skipped
|
Happy to change any of the changes (I can totally understand if we never want to say that TLS is optional, even though I guess that the audience of this document knows that you always upgrade to TLS). I just wanted to update the docs to make it clear that it's actually pretty easy to deploy a Go language server with these instructions - it took me longer to find out what of the docs applies to my case and what doesn't than to actually deploy it :) |
keegancsmith
requested review from
chrismwendt
and removed request for
keegancsmith
|
I think @chrismwendt is the strongest owner here, so will defer to him for accepting it. |
There was a problem hiding this comment.
We've gotten feedback about the README being difficult to read/follow as it is. This PR adds even more information unrelated to a production deployment, so I'm hesitant to accept the changes in this form.
What has been suggested is that this doc be split into different deployment types: k8s, single-Docker image, and local testing. I think that restructuring should happen before we add more deployment types.
Ah, I see, that makes sense. But just so we're on the same page: I was under the assumption that this document here is only about k8s. It doesn't mention single Docker images or local testing. What I'm doing in this PR is adding a little "k8s-testing" information. Are you maybe thinking of the |
This takes the same changes made to the Go lang server documentation in PR #244 and adapts them for the Typescript language server
This takes the same changes made to the Go lang server documentation in PR #244 and adapts them for the Typescript language server
This commit changes the documentation for the Go language server deployment to make it clearer that, you can try out the Go language server support... 1. ... without having to setup TLS/SSL (even though we recommend it!) 2. ... without having to use HTTP basic authentication (even though we recommend it!) In order to that, I did three things: 1. add a suffix to the two sections so it's clear you can skip the "Setup TLS/SSL" and "HTTP Basic authentication" section 2. extract the updating of the global settings into a separate step so readers won't miss it when they skip HTTP basic auth 3. extend the section about global settings to explain what to do when the first two sections were skipped
This takes the same changes made to the Go lang server documentation in PR #244 and adapts them for the Typescript language server
This commit changes the documentation for the Go language server
deployment to make it clearer that, you can try out the Go language
server support...
In order to that, I did three things:
TLS/SSL" and "HTTP Basic authentication" section
readers won't miss it when they skip HTTP basic auth
the first two sections were skipped