Examples - Documentation updates and cleanup #29
Merged
Conversation
This file contains 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
* Cleanup README.md * Small changes to the variables.tf Also added a configuration file for terraform-docs which is now set up to sort the parameters in the variables.tf file based on if they are required or not. On branch brent/examples-docs-upd Changes to be committed: modified: ../.pre-commit-config.yaml new file: ../.terraform-docs.yml modified: anyscale-v2/README.md modified: anyscale-v2/main.tf modified: anyscale-v2/outputs.tf modified: anyscale-v2/variables.tf
Updating example README documentation as well as the variable inputs. Changes to be committed: modified: anyscale-v2-commonname/README.md modified: anyscale-v2-commonname/outputs.tf modified: anyscale-v2-commonname/variables.tf modified: anyscale-v2/README.md modified: anyscale-v2/outputs.tf
Update the README, variables, and outputs. Changes to be committed: modified: anyscale-v2-commonname/README.md modified: anyscale-v2-commonname/main.tf modified: anyscale-v2-commonname/variables.tf modified: anyscale-v2-createendpoints/main.tf modified: anyscale-v2-createendpoints/outputs.tf modified: anyscale-v2-createendpoints/variables.tf
README and main.tf updated Changes to be committed: new file: anyscale-v2-createendpoints/README.md modified: anyscale-v2-createendpoints/main.tf
The variables were missing existing_vpc related variables - they were hard coded in the main.tf. This commit adds the variables and updates main.tf to use them. Changes to be committed: modified: anyscale-v2-createendpoints/README.md modified: anyscale-v2-createendpoints/main.tf modified: anyscale-v2-createendpoints/variables.tf modified: anyscale-v2-existing-vpc/README.md
Additional updates to the readme, outputs, and variables. Changes to be committed: modified: anyscale-v2-createendpoints/outputs.tf modified: anyscale-v2-createendpoints/variables.tf modified: anyscale-v2-existing-vpc/README.md modified: anyscale-v2-existing-vpc/main.tf modified: anyscale-v2-existing-vpc/outputs.tf modified: anyscale-v2-existing-vpc/variables.tf
Update variables, docs, etc. Changes to be committed: modified: anyscale-v2-privatesubnets/README.md modified: anyscale-v2-privatesubnets/main.tf modified: anyscale-v2-privatesubnets/variables.tf
brent-anyscale
added
the
documentation
domcatalano
approved these changes
Jul 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This includes general cleanup of the Examples provided. It includes updates to READMEs, cleanup and more details in the variables.tf files, and additional enhancements.
This also includes a .terraform-docs.yml config file which will now sort parameters in the documentation by required/not required.
Pull request checklist
Please check if your PR fulfills the following requirements:
Pull Request Type
Does this introduce a breaking change?