3379 lsp config documentation and gowork 2

[kaanyalti]

What is the problem this PR solves?

I was running into lsp errors while trying to work on e2e tests. The details of the errors are outlined in the PR itself. This made working on the testing package quite difficult as I was not getting any sort of completions or suggestions.

How does this PR solve the problem?

One of the errors was due to the nested modules. Configuring go workspaces resolves this issue. I configured go.work on my machine and tried to make it work with the build steps as can be seen in this PR; however, I couldn't resolve several issues. In this PR I added go.work and go.work.sum files to the .gitignore file and described how you can configure them. The second issue was due to the build constraints (eg. //go:build e2e). The solution for this is explained in the updated README.

How to test this PR locally

Please make sure that go.work configuration works for you. With the changes in this PR, confirm that you are still getting code suggestions/completions in all the modules in the repo.

Design Checklist

• I have ensured my design is stateless and will work when multiple fleet-server instances are behind a load balancer.
• I have or intend to scale test my changes, ensuring it will work reliably with 100K+ agents connected.
• I have included fail safe mechanisms to limit the load on fleet-server: rate limiting, circuit breakers, caching, load shedding, etc.

Checklist

• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have made corresponding change to the default configuration files
• I have added tests that prove my fix is effective or that my feature works
• I have added an entry in ./changelog/fragments using the changelog tool

Related issues

• Closes LSP config documentation and go.work #3379

[nchaulet]

Thanks for adding those LGTM 🚀

[elastic-sonarqube]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube