website-and-documentation/content/en/docs/components/TEMPLATE.md at 82d424aecaca21aaab7e33e656afac0f4b46d698

forked from DevFW-CICD/website-and-documentation

Stephan Lo 82d424aeca fix(docs): remove Backstage component and add editorial headers

- Remove Backstage component page (not in product structure)
- Add editorial status alert to all draft pages with:
  * Jira ticket reference placeholder
  * Assignee field
  * Draft status indicator
  * Last updated date
  * TODO checklist for completion
- Update component template with editorial header
- Use Docsy alert shortcode (warning style) for professional appearance

2025-11-16 13:42:58 +01:00

2.1 KiB

Raw Blame History

title	linkTitle	weight	description
[Component Name]	[Short Name]	99	[Brief one-line description of the component]

{{% alert title="Draft" color="warning" %}} Editorial Status: This page is currently being developed.

Jira Ticket: TICKET-XXX
Assignee: [Name or Team]
Status: Draft
Last Updated: YYYY-MM-DD
TODO:
- Add detailed component description
- Include usage examples and code samples
- Add architecture diagrams
- Review and finalize content {{% /alert %}}

Overview

[Detailed description of the component - what it is, what it does, and why it exists]

Key Features

[Feature 1]
[Feature 2]
[Feature 3]

Purpose in EDP

[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]

Repository

Code: [Link to source code repository]

Documentation: [Link to component-specific documentation]

Getting Started

Prerequisites

[Prerequisite 1]
[Prerequisite 2]

Quick Start

[Step-by-step guide to get started with this component]

[Step 1]
[Step 2]
[Step 3]

Verification

[How to verify the component is working correctly]

Usage Examples

[Use Case 1]

[Example with code/commands showing common use case]

# Example commands

[Use Case 2]

[Another common scenario]

Integration Points

[Component A]: [How it integrates]
[Component B]: [How it integrates]
[Component C]: [How it integrates]

Configuration

[Key configuration options and how to set them]

Troubleshooting

[Common Issue 1]

Problem: [Description]

Solution: [How to fix]

[Common Issue 2]