hashicorp / consul-aws

Mozilla Public License 2.0
54 stars 17 forks source link

No documentation available for consul-aws #33

Open webdog opened 2 years ago

webdog commented 2 years ago

Hey there!

I am in the process of updating the Learn guide for this tool: https://learn.hashicorp.com/tutorials/consul/sync-aws-services

I wanted to link to this tool's documentation, but looking at consul.io and this repository, I can't seem to locate any documentation. The Learn guide provides sparse configuration information for the available subcommands and parameters, but they aren't contextually relevant for the tutorial, and I'd like to remove them in favor of linking to structured docs.

If I've overlooked something, please let me know! 😺

Thanks!

cc @trujillo-adam for 👀

trujillo-adam commented 2 years ago

This is the first I've heard of this tool. The only docs appear to be the readme for it in the repo. I don't mind keeping the docs there (at least for now). It would probably be relatively light lift to migrate the content to consul.io, but any of these components that version separately have to be compensated for with each Consul release. I don't see the value for such a lightweight, specialty-purpose utility. At the very least, we should ask the engineers to review and make any necessary updates -- tagging @i0rek