Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Enhancement] Provide extensive examples in the docs for created objects (cloud, Kubernetes manifest/YAML) #949

Open
spkane opened this issue Mar 21, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@spkane
Copy link

spkane commented Mar 21, 2024

Description

The current documentation (e.g. AWS Cloud Integration) is very focused on manual setups using very specific tools. It talks you through using tools like eksctl without even sharing the cloud objects or k8s manifests that will be generated. This makes it difficult to follow when you are not using those tools.

At a minimum, it would be nice, if each command, then said, and you will see these objects with configurations similar to this created in your cloud account, and you will see Kubernetes manifests like this applied to your cluster.

  • Along these lines, it would also be wonderful if there was documentation for at least one of the more common automation approaches, like terraform, providing a solid example of how the installation can be achieved with that toolset.
    • A maintained terraform module would be helpful, but honestly, even robust examples would be a vast improvement. Trying to translate the current docs has been pretty challenging.
@spkane spkane added the enhancement New feature or request label Mar 21, 2024
@spkane spkane changed the title [Enhancement] Provide docs for common automation approaches [Enhancement] Provide extensive examples in the docs for created objects (cloud, Kubernetes manifest/YAML) Mar 21, 2024
@chipzoller
Copy link
Contributor

Hi @spkane and thank you for proposing some enhancements here. Regarding your statement:

without even sharing the cloud objects or k8s manifests that will be generated. This makes it difficult to follow when you are not using those tools.

Many of these commands/procedures result in AWS changes. Or were you referring to another section? If so, can you provide the link to the docs you're suggesting enhancements? Could you additionally provide a short example of what you think would be helpful?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants