Skip to content

AGENTS.md

Latest commit

 

History

History
169 lines (137 loc) · 8.01 KB

AGENTS.md

File metadata and controls

169 lines (137 loc) · 8.01 KB

Layer5 Academy Agents Guide

Welcome to the Layer5 Academy Agents documentation. This guide provides instructions and templates for creating exams, learning paths, courses, certifications, and other supported content types in alignment with Layer5 Academy's standards.

Table of Contents

Content Types Supported

Layer5 Academy supports the following content types:

  • Video (.mp4, .webm)
  • Article (.md, .html)
  • Quiz (.yaml, .json)
  • Assignment (.md, .pdf)
  • Interactive Lab (.yaml, .json)
  • External Resource (URL)

Example:

lesson:
    title: "Introduction to Meshery"
    content_type: "video"
    resource: "intro-meshery.mp4"

Exams

Instructions:
Exams are designed to assess learner proficiency on specific topics. Each exam should include clear metadata, a variety of question types, and an answer key.

Template:

exam:
    title: "Exam Title"
    description: "Brief description of the exam."
    duration: "60 minutes"
    passing_score: 70
    questions:
        - type: "multiple-choice"
            question: "What is Meshery?"
            options:
                - "Collaborative Cloud Native Manager"
                - "Container Orchestrator"
                - "CI/CD Tool"
            answer: "Collaborative Cloud Native Manager"
        - type: "true-false"
            question: "Meshery supports Helm."
            answer: true

Learning Paths

Instructions:
Learning paths sequence courses and resources to guide learners through a structured progression. Prerequisites and recommended order should be specified.

Template:

learning_path:
    title: "Learning Path Title"
    description: "Overview of the learning path."
    courses:
        - "Course 1 Title"
        - "Course 2 Title"
    prerequisites:
        - "Prerequisite 1"
        - "Prerequisite 2"

Courses

Instructions:
Courses are comprehensive units containing modules, lessons, and assessments. Each course should be modular and support multiple content types.

Template:

course:
    title: "Course Title"
    description: "Course overview."
    modules:
        - title: "Module 1"
            lessons:
                - title: "Lesson 1"
                    content_type: "video"
                    resource: "lesson1.mp4"
                - title: "Lesson 2"
                    content_type: "article"
                    resource: "lesson2.md"
        - title: "Module 2"
            lessons:
                - title: "Lesson 3"
                    content_type: "quiz"
                    resource: "quiz1.yaml"

Certifications

Instructions:
Certifications validate learner achievement after completing required courses or exams. Include requirements and badge details.

Template:

certification:
    title: "Certification Title"
    description: "Certification details."
    requirements:
        - "Complete Course X"
        - "Pass Exam Y"
    badge: "certification-badge.png"

Certified Meshery Contributor Certification

The Certified Meshery Contributor Certification recognizes individuals who have made significant contributions to the Meshery project, including code contributions, documentation improvements, and community engagement. The Certified Meshery Contributor exam is taken by seasoned Meshery contributors to formally validate their knowledge. Use the following contributing docs as a primary source for questions:

Contribution Guidelines

  • Use the provided templates for consistency.
  • Validate YAML/Markdown syntax before submission.
  • Link resources appropriately and ensure accessibility.
  • Ensure content is accurate, up-to-date, and aligns with Layer5 Academy Documentation.
  • Follow Layer5's standards for inclusivity and clarity.

For more details, refer to the Layer5 Academy Documentation.