updated the readme.md - #36
Open
amitabh90 wants to merge 1 commit into
Open
Conversation
Signed-off-by: amitabh90 <amitabh90.das@gmail.com>
tormath1
reviewed
Aug 14, 2025
| Examples of deploying Flatcar instances with Terraform | ||
|
|
||
| # AWS EKS worker nodes | ||
| :warning: This is really for demo purposes but it can serve as a foundation (for example do not pass the admin configuration through HTTP for workers to join) :warning: |
Contributor
There was a problem hiding this comment.
Suggested change
| :warning: This is really for demo purposes but it can serve as a foundation (for example do not pass the admin configuration through HTTP for workers to join) :warning: | |
| :warning: This is really for demo purposes: do not use those examples in production :warning: |
| - [flatcar-terraform](#flatcar-terraform) | ||
| - [AWS EKS worker nodes](#aws-eks-worker-nodes) | ||
| - [Plain Flatcar instances](#plain-flatcar-instances) | ||
| - [digitalocean](#digitalocean) |
Contributor
There was a problem hiding this comment.
I personally find this approach a bit less intuitive: one need to click here, to be redirected to L46-47 and one must click again on L46 to actually reach the digitalocean folder.
What about simply provide a list of all available examples in alphabetic order:
# Available examples
- [aws](aws)
- ...| - [equinix-metal-aka-packet-without-instance-replacement](#equinix-metal-aka-packet-without-instance-replacement) | ||
| - [qemu-libvirt-without-instance-replacement](#qemu-libvirt-without-instance-replacement) | ||
|
|
||
| ## flatcar-terraform |
Contributor
There was a problem hiding this comment.
I would keep this as it is right now to have the following structure:
## flatcar-terraform
Examples of deploying Flatcar instances with Terraform/OpenTofu. Follow the README instructions in the directories to try it out.
<!-- The warning -->
# Available examples
- [aws](aws)
...
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Title: enhances the flatcar-terraform/README.md documentation
issue 1848 : flatcar/Flatcar#1848
Description:
This PR enhances the flatcar-terraform/README.md documentation for better clarity, usability, and professionalism. The changes focus on navigation, consistency, and readability, making it easier for users and contributors to understand and use the repository. Changes Introduced