Patrick.Sy/website-and-documentation
1
0
Fork 0
forked from DevFW-CICD/website-and-documentation
Code Pull requests Activity
website-and-documentation/content/en/docs/getting-started/_index.md
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

1.9 KiB
Raw Blame History

title linkTitle weight description
Getting Started Getting Started 3 Quick start guides and onboarding information for the Edge Developer Platform.

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

  • Jira Ticket: TBD
  • Assignee: Team
  • Status: Draft - Structure only
  • Last Updated: 2025-11-16
  • TODO:
    • Add concrete quick start steps
    • Include prerequisites and access information
    • Create first application tutorial {{% /alert %}}

Welcome to EDP

This section helps you get started with the Edge Developer Platform, whether you're a developer building applications or a platform engineer managing infrastructure.

Quick Start for Developers

Prerequisites

  • Access to EDP instance
  • Git client installed
  • kubectl configured (for Kubernetes access)
  • Basic knowledge of containers and CI/CD

Your First Application

  1. Access the Platform: Log in to Backstage portal
  2. Clone Repository: Get your application repository from Forgejo/GitLab
  3. Configure Pipeline: Set up CI/CD in Woodpecker or ArgoCD
  4. Deploy: Push code and watch automated deployment

Next Steps

  • Explore available components and services
  • Review platform documentation and best practices
  • Join the developer community

Quick Start for Platform Engineers

Platform Access

  • Kubernetes cluster access
  • Infrastructure management tools
  • Monitoring and observability dashboards

Key Resources

  • Platform architecture documentation
  • Operational runbooks
  • Troubleshooting guides

Documentation Template

When creating "Getting Started" content for a component:

  1. Prerequisites: What users need before starting
  2. Step-by-Step Guide: Clear, numbered instructions
  3. Verification: How to confirm success
  4. Common Issues: FAQ and troubleshooting
  5. Next Steps: Links to deeper documentation