Skip to content

Updated and formatted USAGE.md - #104

Merged
Gogotchuri merged 6 commits into
mainfrom
usage_docs
Jul 24, 2025
Merged

Updated and formatted USAGE.md#104
Gogotchuri merged 6 commits into
mainfrom
usage_docs

Conversation

@Gogotchuri

@Gogotchuri Gogotchuri commented Jul 22, 2025

Copy link
Copy Markdown
Contributor

This PR includes the following changes to the USAGE documentation.

  • Added Emacs configuration with Eglot (A big shoutout to @cassandracomar for providing the working config)
  • Updated IntelliJ docs to recommend using only the official extension for now.
  • Fixed vim-lsp and YouCompleteMe configs (Disclaimer: I'm not confident in the vim-specific configs)
  • Updated Neovim documentation with the latest configuration, which is also the simplest. I'm not proficient in Vim script and have only included the Lua configuration. If anyone feels strongly that we should include a Vim script version of the configuration or configuration for older versions of Neovim, new contributions are always welcome.
  • Fixed the incorrect configuration link in the VSCode documentation.
  • Added "Might require update" to BBEdit 14 config. Which I couldn't test.
  • Added correct configuration for Kate and an additional section to get .tofu files working.
  • I've removed Sublime Text from this documentation, since there is no built-in highlighting mode for Terraform or OpenTofu, and we do not have the resources to maintain additional extensions inside the Organization.

This PR will mostly resolve issues with the USAGE documentation, but we will still need to extend and update it with additional editors and up-to-date configs.

Resolves #48
Partially addresses #99

Checklist

  • I have read the contribution guide.
  • I have not used an AI coding assistant to create this PR.
  • I have written all code in this PR myself OR I have marked all code I have not written myself (including modified code, e.g. copied from other places and then modified) with a comment indicating where it came from.
  • I (and other contributors to this PR) have not looked at the Terraform source code while implementing this PR.
  • If I'm releasing, I have read the releasing guide.

Go checklist

  • I have run golangci-lint on my change and receive no errors relevant to my code.
  • I have run existing tests to ensure my code doesn't break anything.
  • I have added tests for all relevant use cases of my code, and those tests are passing.
  • I have only exported functions, variables and structs that should be used from other packages.
  • I have added meaningful comments to all exported functions, variables, and structs.

Signed-off-by: Ilia Gogotchuri <ilia.gogotchuri0@gmail.com>
Signed-off-by: Ilia Gogotchuri <ilia.gogotchuri0@gmail.com>
Signed-off-by: Ilia Gogotchuri <ilia.gogotchuri0@gmail.com>
@Gogotchuri
Gogotchuri marked this pull request as ready for review July 22, 2025 11:14
@Gogotchuri
Gogotchuri requested a review from a team as a code owner July 22, 2025 11:14
Comment thread docs/USAGE.md Outdated
Comment thread docs/USAGE.md Outdated
Signed-off-by: Ilia Gogotchuri <ilia.gogotchuri0@gmail.com>

@yottta yottta left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good in general. Didn't test the configurations. If you can, would be nice to have those validated.

Comment thread docs/USAGE.md Outdated
Signed-off-by: Ilia Gogotchuri <ilia.gogotchuri0@gmail.com>
Comment thread docs/USAGE.md
Comment thread docs/USAGE.md Outdated
Comment thread docs/USAGE.md

@diofeher diofeher left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

I've approved it, just to unblock you after you fix the typo.

Signed-off-by: Ilia Gogotchuri <ilia.gogotchuri0@gmail.com>
@Gogotchuri
Gogotchuri merged commit db03cc3 into main Jul 24, 2025
21 checks passed
@Gogotchuri
Gogotchuri deleted the usage_docs branch July 24, 2025 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Editor support and USAGE.md

5 participants