fix: change docs

cktf · Aug 31, 2024 · 2486733 · 2486733
1 parent 491be11
commit 2486733
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 81 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,79 +7,67 @@
 
 # [2.0.0](https://github.com/cktf/terraform-gitlab-organization/compare/1.3.1...2.0.0) (2024-08-31)
 
-
 ### Bug Fixes
 
-* change CI ([b249606](https://github.com/cktf/terraform-gitlab-organization/commit/b24960605fa3fc7be0a79f3aee1ef1b99afb47cc))
-
+-   change CI ([b249606](https://github.com/cktf/terraform-gitlab-organization/commit/b24960605fa3fc7be0a79f3aee1ef1b99afb47cc))
 
 ### Features
 
-* add new version ([1e4df2c](https://github.com/cktf/terraform-gitlab-organization/commit/1e4df2ca2e5af55b55c59ee6819fe07a7238c725))
-
+-   add new version ([1e4df2c](https://github.com/cktf/terraform-gitlab-organization/commit/1e4df2ca2e5af55b55c59ee6819fe07a7238c725))
 
 ### BREAKING CHANGES
 
-* organization structure
-
-## [1.3.1](https://github.com/cktf/terraform-gitlab-application/compare/1.3.0...1.3.1) (2022-11-10)
+-   organization structure
 
+## [1.3.1](https://github.com/cktf/terraform-gitlab-organization/compare/1.3.0...1.3.1) (2022-11-10)
 
 ### Bug Fixes
 
-* change version constraints ([5572089](https://github.com/cktf/terraform-gitlab-application/commit/55720899d1e064c6375180d978735d4a5846b5b8))
-
-# [1.3.0](https://github.com/cktf/terraform-gitlab-application/compare/1.2.0...1.3.0) (2022-11-10)
+-   change version constraints ([5572089](https://github.com/cktf/terraform-gitlab-organization/commit/55720899d1e064c6375180d978735d4a5846b5b8))
 
+# [1.3.0](https://github.com/cktf/terraform-gitlab-organization/compare/1.2.0...1.3.0) (2022-11-10)
 
 ### Features
 
-* upgrade dependencies ([7b0f2df](https://github.com/cktf/terraform-gitlab-application/commit/7b0f2df915a376a3951144dd9c4992cd7f21a5a9))
-
-# [1.2.0](https://github.com/cktf/terraform-gitlab-application/compare/1.1.3...1.2.0) (2022-11-05)
+-   upgrade dependencies ([7b0f2df](https://github.com/cktf/terraform-gitlab-organization/commit/7b0f2df915a376a3951144dd9c4992cd7f21a5a9))
 
+# [1.2.0](https://github.com/cktf/terraform-gitlab-organization/compare/1.1.3...1.2.0) (2022-11-05)
 
 ### Features
 
-* add application group id to output values ([ec419c4](https://github.com/cktf/terraform-gitlab-application/commit/ec419c4b21fc104d5c02a08739771db08d48d05b))
-
-## [1.1.3](https://github.com/cktf/terraform-gitlab-application/compare/1.1.2...1.1.3) (2022-11-04)
+-   add organization group id to output values ([ec419c4](https://github.com/cktf/terraform-gitlab-organization/commit/ec419c4b21fc104d5c02a08739771db08d48d05b))
 
+## [1.1.3](https://github.com/cktf/terraform-gitlab-organization/compare/1.1.2...1.1.3) (2022-11-04)
 
 ### Bug Fixes
 
-* change organization name to application ([ce46d34](https://github.com/cktf/terraform-gitlab-application/commit/ce46d34c4251f65d132c588a96aabdcb088acc06))
-
-## [1.1.2](https://github.com/cktf/terraform-gitlab-application/compare/1.1.1...1.1.2) (2022-11-03)
+-   change organization name to organization ([ce46d34](https://github.com/cktf/terraform-gitlab-organization/commit/ce46d34c4251f65d132c588a96aabdcb088acc06))
 
+## [1.1.2](https://github.com/cktf/terraform-gitlab-organization/compare/1.1.1...1.1.2) (2022-11-03)
 
 ### Bug Fixes
 
-* change clear team prefix from repositories key pattern ([b96e102](https://github.com/cktf/terraform-gitlab-application/commit/b96e1023e92762e0fe01fb7f1b357990c26aebd5))
-
-## [1.1.1](https://github.com/cktf/terraform-gitlab-application/compare/1.1.0...1.1.1) (2022-11-03)
+-   change clear team prefix from repositories key pattern ([b96e102](https://github.com/cktf/terraform-gitlab-organization/commit/b96e1023e92762e0fe01fb7f1b357990c26aebd5))
 
+## [1.1.1](https://github.com/cktf/terraform-gitlab-organization/compare/1.1.0...1.1.1) (2022-11-03)
 
 ### Bug Fixes
 
-* remove dependencies ([eb703f9](https://github.com/cktf/terraform-gitlab-application/commit/eb703f97e337fb0512654bcc394a6c28da03693a))
-
-# [1.1.0](https://github.com/cktf/terraform-gitlab-application/compare/1.0.0...1.1.0) (2022-11-03)
+-   remove dependencies ([eb703f9](https://github.com/cktf/terraform-gitlab-organization/commit/eb703f97e337fb0512654bcc394a6c28da03693a))
 
+# [1.1.0](https://github.com/cktf/terraform-gitlab-organization/compare/1.0.0...1.1.0) (2022-11-03)
 
 ### Bug Fixes
 
-* add tenants variable ([889b567](https://github.com/cktf/terraform-gitlab-application/commit/889b5674ea5438101686cab54f6d67f4dee6fde1))
-* change output variable, add public per repository ([e58e64f](https://github.com/cktf/terraform-gitlab-application/commit/e58e64f1ad916646023ddcde6436eb4b3a1a2e72))
-
+-   add tenants variable ([889b567](https://github.com/cktf/terraform-gitlab-organization/commit/889b5674ea5438101686cab54f6d67f4dee6fde1))
+-   change output variable, add public per repository ([e58e64f](https://github.com/cktf/terraform-gitlab-organization/commit/e58e64f1ad916646023ddcde6436eb4b3a1a2e72))
 
 ### Features
 
-* add deploy_key, dependencies, secrets ([8c95951](https://github.com/cktf/terraform-gitlab-application/commit/8c95951e9642c1d353c8acce2504325e5a4d36c3))
+-   add deploy_key, dependencies, secrets ([8c95951](https://github.com/cktf/terraform-gitlab-organization/commit/8c95951e9642c1d353c8acce2504325e5a4d36c3))
 
 # 1.0.0 (2022-11-02)
 
-
 ### Features
 
-* init project ([b70c46f](https://github.com/cktf/terraform-gitlab-application/commit/b70c46f405eb8c1aef7fda6f7dd6e12383457948))
+-   init project ([b70c46f](https://github.com/cktf/terraform-gitlab-organization/commit/b70c46f405eb8c1aef7fda6f7dd6e12383457948))
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
-# Terraform Gitlab Application
+# Terraform Gitlab Organization
 
-![pipeline](https://github.com/cktf/terraform-gitlab-application/actions/workflows/cicd.yml/badge.svg)
-![release](https://img.shields.io/github/v/release/cktf/terraform-gitlab-application?display_name=tag)
-![license](https://img.shields.io/github/license/cktf/terraform-gitlab-application)
+![pipeline](https://github.com/cktf/terraform-gitlab-organization/actions/workflows/cicd.yml/badge.svg)
+![release](https://img.shields.io/github/v/release/cktf/terraform-gitlab-organization?display_name=tag)
+![license](https://img.shields.io/github/license/cktf/terraform-gitlab-organization)
 
-**Application** is a Terraform module useful for creating multiple subgroups and projects in **Gitlab**
+**Organization** is a Terraform module useful for creating multiple groups and projects in **Gitlab**
 
 ## Installation
 
@@ -17,58 +17,44 @@ terraform init
 ## Usage
 
 ```hcl
-module "application" {
-  source = "cktf/application/gitlab"
+module "gitlab" {
+  source = "cktf/organization/gitlab"
 
-  group_id    = 0
-  path        = "myorg"
-  name        = "My Application"
-  description = "My Application Group"
-  teams = {
+  path = "myorg"
+  name = "My Org"
+  desc = "My Org Team"
+
+  groups = {
     backend = {
-      name        = "Backend"
-      description = "Backend Team"
+      path = "backend"
+      name = "Backend"
+      desc = "Backend Team"
     }
     frontend = {
-      name        = "Frontend"
-      description = "Frontend Team"
+      path = "frontend"
+      name = "Frontend"
+      desc = "Frontend Team"
     }
   }
-  repositories = {
-    application = {
-      team        = ""
-      name        = "Application"
-      description = "Application Repository"
-      deploy_keys = {}
-      secrets     = {}
-    }
-    backend_nodejs = {
-      team        = "backend"
-      name        = "NodeJS"
-      description = "NodeJS Repository"
-      deploy_keys = {}
-      secrets     = {}
-    }
-    backend_golang = {
-      team        = "backend"
-      name        = "Golang"
-      description = "Golang Repository"
-      deploy_keys = {}
-      secrets     = {}
+
+  projects = {
+    backend1 = {
+      path  = "backend1"
+      name  = "Backend1"
+      desc  = "Backend1 Project"
+      group = "backend"
     }
-    frontend_react = {
-      team        = "frontend"
-      name        = "React"
-      description = "React Repository"
-      deploy_keys = {}
-      secrets     = {}
+    frontend1 = {
+      path  = "frontend1"
+      name  = "Frontend1"
+      desc  = "Frontend1 Project"
+      group = "frontend"
     }
-    frontend_vuejs = {
-      team        = "frontend"
-      name        = "VueJS"
-      description = "VueJS Repository"
-      deploy_keys = {}
-      secrets     = {}
+    frontend2 = {
+      path  = "frontend2"
+      name  = "Frontend2"
+      desc  = "Frontend2 Project"
+      group = "frontend"
     }
   }
 }