From 2f4290a09c1aae1f9a719d638c38820b13887656 Mon Sep 17 00:00:00 2001 From: "franz.germann1" Date: Wed, 18 Dec 2024 14:43:10 +0100 Subject: [PATCH] forgejo.md styling --- docs/userguide/backstage.md | 14 +++++++------- docs/userguide/forgejo.md | 31 ++++++++++++++++++++----------- 2 files changed, 27 insertions(+), 18 deletions(-) diff --git a/docs/userguide/backstage.md b/docs/userguide/backstage.md index 783d692..dc6d770 100644 --- a/docs/userguide/backstage.md +++ b/docs/userguide/backstage.md @@ -4,7 +4,7 @@ Backstage is a Platform Portal for building and managing internal developer tool --- -## Key Features of Backstage as a Platform Portal +## Key features of Backstage as a Platform Portal ### 🤝 Tool Integration @@ -37,21 +37,21 @@ LINK 2. **Navigate to "Create"** In the left-hand menu, click on the "Create" option. This will open a page with available component templates. -![step 2](../ressources/1.png) + ![step 2](../ressources/1.png) -3. **Select a Template** +3. **Select a template** Choose the template that suits your needs. For example, the "Spring PetClinic Template" may be shown in screenshots. -4. **Fill Out the Required Fields** +4. **Fill out the required fields** Enter the necessary information that the template requires to create the component. -![step 2](../ressources/2.png) + ![step 2](../ressources/2.png) -5. **Monitor the Template Execution** +5. **Monitor the template execution** After submission, you will be redirected to a page showing the status of each step. If all steps are completed successfully, your component is ready for use. -![step 2](../ressources/3.png) + ![step 2](../ressources/3.png) --- diff --git a/docs/userguide/forgejo.md b/docs/userguide/forgejo.md index b6ab67f..e4e66bf 100644 --- a/docs/userguide/forgejo.md +++ b/docs/userguide/forgejo.md @@ -1,36 +1,45 @@ +# Forgejo -In our EDP, we utilize Forgejo for Git hosting, Forgejo Registry for container image storage, and Forgejo Runner for continuous integration (CI) workflows. Here's a brief overview of these components and their roles. +In our EDP, we utilize Forgejo for Git hosting, Forgejo Registry for container image storage, and Forgejo Runner for [continuous integration (CI) workflows](ci-workflow.md). Here's a brief overview of these components and their roles. -## Forgejo +--- + +## Features **Forgejo** is a Git server that provides version control for your code repositories. It offers: -- **Code Hosting**: Store and manage your source code repositories. -- **Collaboration Tools**: Features like pull requests, issue tracking, and code reviews to enhance teamwork. -- **Git Actions**: Native support for CI/CD pipelines using Forgejo Actions. +- **💾 Code Hosting:** Store and manage your source code repositories. +- **👥 Collaboration Tools:** Features like pull requests, issue tracking, and code reviews to enhance teamwork. +- **✅ Git Actions:** Native support for CI/CD workflows using Forgejo Actions. Forgejo serves as the central hub for managing source code and related development activities. +--- + ## Forgejo Registry **Forgejo Registry** is a container image registry integrated with Forgejo. It allows you to: -- **Store Docker Images**: Save and manage container images for deployment. -- **Version Control**: Keep track of different versions of your container images. -- **Integration with CI Pipelines**: Store images built by CI workflows for future deployment. +- **🐳 Store Docker Images**: Save and manage container images for deployment. +- **📜 Version Control**: Keep track of different versions of your container images. +- **⚙️ Integration with CI Workflows**: Store images built by CI workflows for future deployment. The Forgejo Registry simplifies the process of managing container images and ensures they are readily available for deployment. +--- + ## Forgejo Runner **Forgejo Runner** is a tool used to execute CI/CD workflows defined in Forgejo Actions. It provides: -- **Pipeline Execution**: Runs automated tasks such as building, testing, and deploying code. -- **Integration with Forgejo**: Seamless execution of workflows hosted on the Forgejo Git server. -- **Image Building**: Builds Docker images and pushes them to the Forgejo Registry. +- **▶️ Pipeline Execution**: Runs automated tasks such as building, testing, and deploying code. +- **⚙️ Integration with Forgejo**: Seamless execution of workflows hosted on the Forgejo Git server. +- **⚒️ Image Building**: Builds Docker images and pushes them to the Forgejo Registry. Forgejo Runner ensures that your CI/CD processes run smoothly and consistently. +--- + ## 🔗 References * [Forgejo Documentation & Community](https://forgejo.org/) * [Forgejo Runner Guildes & Documentation](https://forgejo.org/docs/latest/admin/runner-installation/)