|
| 1 | +--- |
| 2 | +title: Using Academy Content Template Creator |
| 3 | +weight: 6 |
| 4 | +description: > |
| 5 | + |
| 6 | +categories: [Academy] |
| 7 | +tags: [Academy] |
| 8 | +aliases: |
| 9 | +- /cloud/academy/using-academy-content-template-creator |
| 10 | +- /cloud/academy/using-content-template-creator |
| 11 | +- /cloud/academy/academy-content-template-creator-guide |
| 12 | +--- |
| 13 | + |
| 14 | +The Academy Content Template Creator is a step-by-step wizard that helps you create structured templates for your Academy content. This generator streamlines the process of |
| 15 | +creating learning paths, challenges, and certifications by collecting all necessary metadata and generating a ready-to-use template. |
| 16 | + |
| 17 | + |
| 18 | +## Getting Started |
| 19 | + |
| 20 | +1. Access the Creator: Click on the "Create New Content" card in your Academy dashboard |
| 21 | +2. Create Your Content: The wizard will guide you through **5 essential steps** to create your content template |
| 22 | + |
| 23 | +Since it's straightforward, let's walk through a practical example to demonstrate the process. |
| 24 | + |
| 25 | +## Example: Creating "Meshery Contributors Certification" |
| 26 | + |
| 27 | +This example demonstrates how to use the **Academy Content Template Creator** to build a **certification** program for **Meshery contributors**. Each step shows what information to enter, followed by specific example values. |
| 28 | + |
| 29 | +### Step 1: Basic Information |
| 30 | + |
| 31 | +- Type: Choose "Certification" from Learning Path, Challenge, or Certification |
| 32 | +- Title: "Meshery Contributors Certification" |
| 33 | +- Description: "A comprehensive certification program for developers looking to become active contributors to Meshery" |
| 34 | + |
| 35 | +### Step 2: Content Details |
| 36 | + |
| 37 | +<!-- - Level: Intermediate (assumes basic cloud-native knowledge) --> |
| 38 | +- Categories: "open-source, cloud-native" |
| 39 | +- Add Tags: "meshery", "kubernetes", "golang", "contribution", "open-source" |
| 40 | +- Banner Image: "images/meshery-contributors-banner.svg" |
| 41 | + |
| 42 | +### Step 3: Content Access |
| 43 | + |
| 44 | +- Workspace: "Meshery Academy" |
| 45 | +- Team: "Contributors Program" |
| 46 | +- Access Status: Enabled |
| 47 | +- Content Access End Date: Leave blank for permanent access (Meshery always welcomes contributors) |
| 48 | + |
| 49 | +**Understanding Access Status: Enabled vs Disabled** |
| 50 | + |
| 51 | +The Access Status setting in Step 3 controls the visibility and accessibility of your Academy content to users. |
| 52 | + |
| 53 | +**Enabled Status Behavior:** |
| 54 | +- **Visible**: Content appears in Academy catalogs and search results |
| 55 | +- **Accessible**: Users with proper permissions can view and interact with the content |
| 56 | +- **Active**: All features work normally (enrollment, progress tracking, badge awarding) |
| 57 | +- **Discoverable**: Content shows up in filtered searches and category browsing |
| 58 | + |
| 59 | +**Disabled Status Behavior:** |
| 60 | +- **Hidden**: Content does not appear in public Academy catalogs |
| 61 | +- **Inaccessible**: Users cannot access the content even with direct links |
| 62 | +- **Inactive**: No progress tracking or badge awarding occurs |
| 63 | +- **Non-discoverable**: Content is excluded from search results and browsing |
| 64 | + |
| 65 | +**For the Meshery Contributors Certification example:** |
| 66 | + |
| 67 | +*If Enabled:* |
| 68 | +- Contributors can immediately find and enroll in the certification |
| 69 | +- Progress tracking begins upon enrollment |
| 70 | +- Badge is awarded upon successful completion |
| 71 | +- Content appears in the Contributors Program workspace |
| 72 | + |
| 73 | +*If Disabled:* |
| 74 | +- Certification is hidden from the Contributors Program |
| 75 | +- No new enrollments possible |
| 76 | +- Existing progress is paused |
| 77 | +- Content remains invisible until re-enabled |
| 78 | + |
| 79 | +### Step 4: Recognition |
| 80 | + |
| 81 | + |
| 82 | +The Recognition step defines the badge or certificate awarded upon completion. You have two options: |
| 83 | +- **Use Existing Recognition**: Choose from the Layer5 collection |
| 84 | +- **Create New Recognition**: Design a custom badge with an image URL |
| 85 | + |
| 86 | +**For our example:** |
| 87 | +- Create a "Meshery Contributor" badge with the Meshery logo |
| 88 | + |
| 89 | + |
| 90 | +### Step 5: Generate Template |
| 91 | + |
| 92 | + |
| 93 | +After clicking "Continue" in Step 4, a success notification appears in the bottom-right corner confirming your template has been created successfully. |
| 94 | + |
| 95 | +{{< alert type="info" title="Navigation Between Steps" >}} |
| 96 | +You can navigate back to any previous step to make modifications. When you return to earlier steps and make changes, your entries in the subsequent steps will remain intact. |
| 97 | +{{< /alert >}} |
| 98 | + |
| 99 | + |
| 100 | +**Generated Template Output for Meshery Contributors Certification:** |
| 101 | + |
| 102 | +This template provides the YAML front matter metadata for static site generators (like Hugo/Jekyll). After copying it, we can directly create new content files in our Academy repository. |
| 103 | + |
| 104 | +```yaml |
| 105 | +--- |
| 106 | +type: "certification" |
| 107 | +title: "Meshery Contributors Certification" |
| 108 | +description: "A comprehensive certification program for developers looking to become active contributors to Meshery" |
| 109 | +weight: 1 |
| 110 | +banner: "images/meshery-contributors-banner.svg" |
| 111 | +id: "unique-content-id" |
| 112 | +level: "beginner" |
| 113 | +--- |
| 114 | + |
| 115 | +Provide a brief summary of what learners will gain. |
| 116 | +<!-- Add your Academy content here --> |
| 117 | +``` |
| 118 | + |
| 119 | +{{< alert type="info" title="Important Reference IDs" >}} |
| 120 | +Make note of two key identifiers for your content files: |
| 121 | +- **Content ID**: Unique identifier for this specific content |
| 122 | +- **Organization ID**: Your organization's identifier (remains constant) |
| 123 | +{{< /alert >}} |
| 124 | + |
| 125 | +{{< alert type="info" title="Content ID Updates" >}} |
| 126 | +If you click "Back" and return to Step 5, a new Content ID will be generated. Simply use the new ID and discard the previous one. |
| 127 | +{{< /alert >}} |
| 128 | + |
| 129 | +### Next Steps |
| 130 | + |
| 131 | +After generating our template: |
| 132 | + |
| 133 | +1. **Copy the Template**: Use the provided copy button to get your front matter |
| 134 | +2. **Create Your Content File**: Paste the template into a new .md file in your academy repository |
| 135 | +3. **Add Your Content**: Replace the placeholder comment with your actual learning material |
| 136 | +4. **Test and Review**: Preview your content before publishing |
| 137 | +5. **Engage the Community**: Share your content with relevant teams and gather feedback |
| 138 | + |
| 139 | +### Invitation |
| 140 | + |
| 141 | + |
| 142 | +auto-invitation-details.png |
0 commit comments