How to create a new Inventory Mission

admin
Justin W. Flory
Guidance on creating a new Mission in the Open Source Inventory.

This how-to article explains how to create a new Mission in the Open Source Inventory.

1. Steps ðŸ”—

  1. Copy the Mission template as a new file using the file committed at content/meta/_template.en.adoc.

  2. Edit the template front-matter to include a weight, description, tags, and categories (see descriptions below).

  3. Edit the content using the questions in the template as structural guidelines.

  4. Remove draft: true from the front-matter.

  5. Publish changes and submit a Pull Request.

2. Front-matter data values ðŸ”—

All Missions (and all content on the site) should specify the following required metadata:

title: Build a rocketship (1)
description: Embark on a new mission to build your first rocketship to Mars. (2)
categories: "missions" (3)
tags: ["design", "hardware", "teamwork"] (4)

  1. title is a noun in plural form. It clearly defines what the Mission topic is.

  2. description is one, at most two, sentences to describe the Mission topic.

  3. categories is a single value and must always be set to missions for a new Mission.

  4. tags is a descriptive list of words to describe key elements of the Mission. Check other Missions to see tags already in use.

Updated on 08 Aug 2024