From c4cc0630c07c7626a0c31181c0354f369e5ac601 Mon Sep 17 00:00:00 2001 From: Kamran Ahmed Date: Fri, 21 Jun 2024 21:22:16 +0100 Subject: [PATCH] Add basic content for hcl --- scripts/editor-roadmap-content.ts | 4 ++-- .../terraform/content/cac-vs-iac@UsINvx84pBF1hp8XoLF4c.md | 4 +++- .../hashicorp-config-language-hcl@qhO7CY-1_vuh2BVJYQCzh.md | 4 +++- .../content/installing-terraform@AYtBLFU1nowEq-EVlXrEZ.md | 6 +++++- .../terraform/content/introduction@h6qRrUe-bn25s0UkxU600.md | 4 +++- .../content/usecases-and-benefits@hRIDJHIxWc5Iav7tsu8l-.md | 4 +++- .../terraform/content/what-is-hcl@Hma2IgatFME8STHPwpeMG.md | 4 +++- .../content/what-is-terraform@CU9V3iRdssamsG-xMouXT.md | 4 +++- 8 files changed, 25 insertions(+), 9 deletions(-) diff --git a/scripts/editor-roadmap-content.ts b/scripts/editor-roadmap-content.ts index 2fd034e89..dcc0a93f1 100644 --- a/scripts/editor-roadmap-content.ts +++ b/scripts/editor-roadmap-content.ts @@ -104,9 +104,9 @@ function writeTopicContent( ) { let prompt = `I will give you a topic and you need to write a brief introduction for that with regards to "${roadmapTitle}". Your format should be as follows and be in strictly markdown format: -# (Put a heading for the topic without adding parent "Subtopic in Topic" or "Topic in Roadmap" etc.) +# (Put a heading for the topic without adding parent "Subtopic in Topic" or "Topic in Roadmap" or "Subtopic under XYZ" etc.) -(Write me a brief introduction for the topic with regards to "${roadmapTitle}") +(Briefly explain the topic in one paragraph using simple english with regards to "${roadmapTitle}". Don't start with explaining how important the topic is with regard to "${roadmapTitle}". Don't say something along the lines of "XYZ plays a crucial role in ${roadmapTitle}". Don't include anything saying "In the context of ${roadmapTitle}". Instead, start with a simple explanation of the topic itself. For example, if the topic is "React", you can start with "React is a JavaScript library for building user interfaces." and then you can explain how it is used in "${roadmapTitle}".) `; if (!parentTopic) { diff --git a/src/data/roadmaps/terraform/content/cac-vs-iac@UsINvx84pBF1hp8XoLF4c.md b/src/data/roadmaps/terraform/content/cac-vs-iac@UsINvx84pBF1hp8XoLF4c.md index feb5b1ee7..415b9271c 100644 --- a/src/data/roadmaps/terraform/content/cac-vs-iac@UsINvx84pBF1hp8XoLF4c.md +++ b/src/data/roadmaps/terraform/content/cac-vs-iac@UsINvx84pBF1hp8XoLF4c.md @@ -1 +1,3 @@ -# CaC vs IaC \ No newline at end of file +# CaC vs IaC + +CaC (Configuration as Code) and IaC (Infrastructure as Code) are both ways to manage infrastructure resources, but they focus on different things. CaC deals with setting up and managing the software and settings within your servers, like user settings and app configs. Examples of CaC tools include Ansible and Puppet. IaC, on the other hand, is about managing the underlying infrastructure, like virtual machines, networks, and storage. Examples of IaC tools include Terraform and AWS CloudFormation. So, while IaC sets up the environment, CaC ensures the software within that environment runs correctly. \ No newline at end of file diff --git a/src/data/roadmaps/terraform/content/hashicorp-config-language-hcl@qhO7CY-1_vuh2BVJYQCzh.md b/src/data/roadmaps/terraform/content/hashicorp-config-language-hcl@qhO7CY-1_vuh2BVJYQCzh.md index ec45ad88e..ef46fcf02 100644 --- a/src/data/roadmaps/terraform/content/hashicorp-config-language-hcl@qhO7CY-1_vuh2BVJYQCzh.md +++ b/src/data/roadmaps/terraform/content/hashicorp-config-language-hcl@qhO7CY-1_vuh2BVJYQCzh.md @@ -1 +1,3 @@ -# Hashicorp Config. Language (HCL) \ No newline at end of file +# HashiCorp Configuration Language (HCL) + +HashiCorp Configuration Language (HCL) is a configuration language built by HashiCorp that is used for configuring products in the HashiCorp ecosystem. With its human-readable style, HCL is designed to strike a balance between a generic configuration language like JSON or YAML and a high-level scripting language. In relation to the Terraform Roadmap, HCL is the primary language used for writing Terraform configuration files, thus making it a fundamental part of defining and providing data center infrastructure in a descriptive manner. \ No newline at end of file diff --git a/src/data/roadmaps/terraform/content/installing-terraform@AYtBLFU1nowEq-EVlXrEZ.md b/src/data/roadmaps/terraform/content/installing-terraform@AYtBLFU1nowEq-EVlXrEZ.md index 301046306..5a7f0ad9f 100644 --- a/src/data/roadmaps/terraform/content/installing-terraform@AYtBLFU1nowEq-EVlXrEZ.md +++ b/src/data/roadmaps/terraform/content/installing-terraform@AYtBLFU1nowEq-EVlXrEZ.md @@ -1 +1,5 @@ -# Installing Terraform \ No newline at end of file +# Installing Terraform + +Follow the instructions given in the following URL to install terraform: + +- [@article@Installing Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) \ No newline at end of file diff --git a/src/data/roadmaps/terraform/content/introduction@h6qRrUe-bn25s0UkxU600.md b/src/data/roadmaps/terraform/content/introduction@h6qRrUe-bn25s0UkxU600.md index f6ecaa676..375940e3c 100644 --- a/src/data/roadmaps/terraform/content/introduction@h6qRrUe-bn25s0UkxU600.md +++ b/src/data/roadmaps/terraform/content/introduction@h6qRrUe-bn25s0UkxU600.md @@ -1 +1,3 @@ -# Introduction \ No newline at end of file +# Introduction + +Terraform is a powerful tool designed by HashiCorp that helps you set up, manage, and update infrastructure safely and efficiently across various cloud providers. Think of it as a way to define your cloud resources—like servers, storage, and networks—using a simple code format. This makes it easier to automate, share, and manage your infrastructure, ensuring that everything is consistent and can be quickly reproduced or modified as needed. \ No newline at end of file diff --git a/src/data/roadmaps/terraform/content/usecases-and-benefits@hRIDJHIxWc5Iav7tsu8l-.md b/src/data/roadmaps/terraform/content/usecases-and-benefits@hRIDJHIxWc5Iav7tsu8l-.md index bd600c1cc..5b0d91f78 100644 --- a/src/data/roadmaps/terraform/content/usecases-and-benefits@hRIDJHIxWc5Iav7tsu8l-.md +++ b/src/data/roadmaps/terraform/content/usecases-and-benefits@hRIDJHIxWc5Iav7tsu8l-.md @@ -1 +1,3 @@ -# Usecases and Benefits \ No newline at end of file +# Benefits of Terraform + +Using Terraform offers numerous benefits. It allows you to define your infrastructure as code (IaC), making it human-readable, versioned, and shareable. Its multi-cloud support means you can manage resources consistently across various cloud providers and on-premises environments. By automating infrastructure provisioning and management, Terraform reduces manual errors and speeds up deployments. Version control integration ensures you can track changes, roll back when needed, and collaborate effectively with team members. Terraform's use of templates and modules ensures configuration consistency and reusability across projects and environments, while its state management capabilities keep track of existing resources for efficient updates. \ No newline at end of file diff --git a/src/data/roadmaps/terraform/content/what-is-hcl@Hma2IgatFME8STHPwpeMG.md b/src/data/roadmaps/terraform/content/what-is-hcl@Hma2IgatFME8STHPwpeMG.md index 3de0ed090..a3c6bc6e0 100644 --- a/src/data/roadmaps/terraform/content/what-is-hcl@Hma2IgatFME8STHPwpeMG.md +++ b/src/data/roadmaps/terraform/content/what-is-hcl@Hma2IgatFME8STHPwpeMG.md @@ -1 +1,3 @@ -# What is HCL? \ No newline at end of file +# What is HCL? + +HCL, or HashiCorp Configuration Language, is a human-readable language for DevOps tools. It is used to code infrastructure management and service orchestration in a clear and manageable way. Several HashiCorp products, including Terraform, use HCL as their primary configuration language. Terraform uses HCL to provision and manage cloud resources efficiently. Its clear syntax and structure are instrumental in creating resource modules and configurations that align with the Terraform Roadmap's goals for providing a seamless, user-friendly platform for infrastructure as code. \ No newline at end of file diff --git a/src/data/roadmaps/terraform/content/what-is-terraform@CU9V3iRdssamsG-xMouXT.md b/src/data/roadmaps/terraform/content/what-is-terraform@CU9V3iRdssamsG-xMouXT.md index 80db28bb1..05c634338 100644 --- a/src/data/roadmaps/terraform/content/what-is-terraform@CU9V3iRdssamsG-xMouXT.md +++ b/src/data/roadmaps/terraform/content/what-is-terraform@CU9V3iRdssamsG-xMouXT.md @@ -1 +1,3 @@ -# What is Terraform? \ No newline at end of file +# What is Terraform? + +Terraform is a powerful tool designed by HashiCorp that helps you set up, manage, and update infrastructure safely and efficiently across various cloud providers. Think of it as a way to define your cloud resources—like servers, storage, and networks—using a simple code format. This makes it easier to automate, share, and manage your infrastructure, ensuring that everything is consistent and can be quickly reproduced or modified as needed. \ No newline at end of file