Skip to content

Reference, Hugo Taxonomies

Brian McClain edited this page Oct 12, 2021 · 5 revisions

Hugo defines Taxonomies that may be used in the front matter of Markdown documents. This site uses the following taxonomies:

Level 1 and Level 2 Topics

Topics should always be included in front matter for all content. Topics are divided into two levels. These levels are the primary method for how the site navigation for content is built. These levels must be one of the following options and must appear exactly as follows:

Modern Applications

Modern Application Basics

level1: Modern App Basics
level2: Modern Development Concepts
level1: Modern App Basics
level2: DevOps Practices
level1: Modern App Basics
level2: Kubernetes Platform

Modernizing Legacy Applications

level1: Modernizing Legacy Applications
level2: Deconstruction
level1: Modernizing Legacy Applications
level2: Packaging, Operating, and Outside Enhancements

Agile Transformation and Practices

level1: Agile Transformation and Practices
level2: Agile Development
level1: Agile Transformation and Practices
level2: Team Tips

Application Development

Building Modern Applications

level1: Building Modern Applications
level2: Microservice Patterns
level1: Building Modern Applications
level2: Frameworks and Languages
level1: Building Modern Applications
level2: Modern Development Practices
level1: Building Modern Applications
level2: Services

Deploying Modern Applications

level1: Deploying Modern Applications
level2: Packaging and Publishing
level1: Deploying Modern Applications
level2: CI/CD, Release Pipelines

Managing and Operating Applications

level1: Managing and Operating Applications
level2: Metrics, Tracing, and Monitoring
level1: Managing and Operating Applications
level2: Preparing and Deploying Kubernetes Workloads

Kubernetes Platform

Building Kubernetes Runtime

level1: Building Kubernetes Runtime
level2: Application Platform on Kubernetes
level1: Building Kubernetes Runtime
level2: Building Your Kubernetes Platform

Managing and Operating Kubernetes

level1: Managing and Operating Kubernetes
level2: Monitoring and Observing Kubernetes
level1: Managing and Operating Kubernetes
level2: Kubernetes Architecture
level1: Managing and Operating Kubernetes
level2: Preparing and Deploying Kubernetes Workloads

Securing Kubernetes

level1: Securing Kubernetes
level2: Backup and Restore
level1: Securing Kubernetes
level2: Access and Security

Tags

Tags appear in the tags section of the front matter. Usually tags refer to a specific technology or technology area. 'tags' are free form at this point and can be anything. They are not surfaced directly at this point and mostly aid in search. That said, there are some guidelines:

  • Tags should be capitalized -- Tags should start with a capital letter, and if multi-word, each major word should also be capitalized (title case).
  • Tags should still be pretty general -- In most cases, tags should not refer to a very particular tool or product. Instead, at this point, and in most cases, tags should remain pretty "top-level". For example: a piece on VMware Tanzu Build Service could include tags VMware, Tanzu, and Tanzu Build Service. Since we don't have a lot of content to organize for Tanzu Build Service, it is probably okay to just use Tanzu for the tag.

Some example tags

API, Security, Java, Docker, knative, Microservices, Python, .NET, Tanzu, Automation, Ingress, Event Streaming, Containers, Observability, Reactive, Serverless, etc

Team

Use the team taxonomy to attribute one or more authors to a piece of content.

Featured Content

Content may be tagged as featured: true along with a weight in the front matter to appear in the Featured section on the home page. Only three will appear at once.

Clone this wiki locally