Skip to content

Front Matter Tags for FAQs

anthonyvetter edited this page Aug 6, 2021 · 2 revisions

Guides and Blog posts can add a Frequently Asked Questions (FAQ) section to the bottom of content. Possible use cases for this could include a quiz-style section (i.e. "What Did You Learn?") or a handy way so section off a Call to Action (CTA) (i.e. How do I learn more about A, B, C?"). Also handy for driving SEO for posts.

This is done with optional front matter tags. Below is an example from an ArgoCD guide. See here for what it looks like rendered (scroll to the bottom).

---
date: '2020-05-05'
description: Deploy applications to Kubernetes with ArgoCD, a declarative GitOps tool
  that is lightweight and easy to configure.
lastmod: '2021-03-07'
linkTitle: ArgoCD
metaTitle: Using ArgoCD with Kubernetes-Native Continuous Delivery
patterns:
- Deployment
tags:
- CI-CD
- ArgoCD
team:
- Tony Vetter
title: Getting Started with ArgoCD on Kubernetes
topics:
- CI-CD
oldPath: "/content/guides/ci-cd/argocd-gs.md"
aliases:
- "/guides/ci-cd/argocd-gs"
faqs:
  faq:
    - question: How do you install ArgoCD on Kubernetes?
      answer: After creating a Kubernetes cluster, ArgoCD can be installed with two simple commands. First, create a namespace to install the ArgoCD and run the command `kubectl create namespace argocd`. Finally, apply the script `kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yaml` to finish the install.
    - question: What are the benefits of using ArgoCD on Kubernetes?
      answer: Because ArgoCD can apply git repository configurations to Kubernetes, it assists in the lifecycle management and accelerated deployment of [cloud-native applications](https://tanzu.vmware.com/cloud-native).
    - question: How do you install ArgoCD CLI?
      answer: On Mac, the ArgoCD CLI can be installed with `brew`, where there is a tap for ArgoCD. Otherwise, the binary will need to be installed by navigating to ArgoCD releases page, installing the correct version appropriate for your platform, renaming the file, modifying the command, logging in, and deploying your application.
    - question: How do you deploy apps to ArgoCD in Kubernetes?
      answer: After Installation of the ArgoCD CLI, to deploy your applications with ArgoCD, first tell ArgoCD about your deployment target Kubernetes cluster using the command `argocd cluster add target-k8s`, then configure ArgoCD to pull the image using [spring-petclinic](https://github.com/spring-projects/spring-petclinic ). Finally, push your container to DockerHub and create your own configuration files, or [fork our repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) into your own.
    - question: How do you add a Kubernetes cluster to ArgoCD?
      answer: Kubernetes clusters can be added to ArgoCD by installing the proper configuration files, installing ArgoCD on a Kubernetes cluster, then starting both the target cluster and the cluster in which you installed ArgoCD.
    - question: What is ArgoCD sync?
      answer: “Sync” is the terminology ArgoCD uses to describe the application on your target cluster as being up to date with the sources ArgoCD is pulling from.
---
Clone this wiki locally