kral2 / oci-tf-template-repo Goto Github PK

Once the template repo is cloned, there is some work left to the user to make the most of it:

• install any prerequisite,
• initialize tooling (pre-commit),
• setup any infrastructure required for remote-backend

An idea, is to create a install script that would be part of the repo and when executed, would take care of all theses tasks.

README is using terraform-docs to autogenerate terraform related information (inputs, variables, ouputs, requirements).

The Table of Content requires manual updates. Project like md-toc would solve the problem.

README have some outdated information that needs to be updated. Some instructions on how to use this repo also needs to be revisited as the gh command line tool now have fixed some old bugs.

"Requirement" section

• Give some pointers about how to satisfy the requirements. Maybe build an automated install script?

"how to use" section

• give exact command on how to clone this repo
• adjust backend related message to suggest it is optional

"Features" section

• give some basic information about pre-commit, e.g. the fact that you need to initialize it before it becomes active
• review "tf config fiels" sub-section, some outdated information over there.

The current template repo readme contains all the information related to the template usage. This can add noise when starting a fresh new repo.

The idea is to have a minimal README that can be quickly cleaned up, and adding a link to the template repo usage.

• move repo related doc under /doc
• create a minimal README, with a link to the full doc
• same approach for CHANGELOG.md

Let's comment the content of this file, so a freshly cloned repo will be functional immediately, without any preparatory work related to the declared S3 backend.

remote-backend.tf will not be enforced anymore, but will be there just as an optional boilerplate. The template repo user can choose to keep Terraform statefile locally, or configure another remote backend.

• comment remote-backend.tf and update its content to explain the "optional" usage logic
• update README information