claranet / claranet/tfwrapper

docs: Missing reference to Claranet Terraform modules

Open
#245 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
155
Forks
26
PR merge metrics
No merged PRs in 30d

Description

Since the tfwrapper is Claranet-oriented, then it is valid to expect it would support use of Claranet production-ready Terraform modules.

I think, the wrapper documentation, especially Stacks file structure, should touch on best practices on using the modules in a project:

  • Does tfwrapper offer any features to refer/link/import the modules?
  • If not, where it is suggested to put them?
  • Share between account/environment/stack or make as local as possible?
  • Host them as a copy or via Git submodule?
    ...

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked documentation section, “Stacks file structure,” and review how tfwrapper projects currently organize Terraform modules. Document whether module references are supported and give recommendations for placement, sharing, and hosting; it is done when the listed questions are answered in the wrapper documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
terraform
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.