style fixes for ci-workflow.md and backstage.md
This commit is contained in:
parent
932d607f31
commit
661edcf761
3 changed files with 46 additions and 38 deletions
|
|
@ -38,12 +38,12 @@ One usecase to demonstrate the capabilities of our tool is the PetClinic Applica
|
|||
|
||||
Our documentation is designed to be easily accessible regardless of your environment. Here are three primary ways to view it:
|
||||
|
||||
1. **Backstage in Our OSC**
|
||||
1. **in Our Open Sovereign Cloud**
|
||||
Our documentation can be easily accessed through a Backstage instance hosted on our Open Sovereign Cloud (OSC). Simply log in to our OSC Backstage platform to read through the documentation.
|
||||
|
||||
2. **Local Backstage in a Kind Cluster**
|
||||
2. **in a local kind Cluster**
|
||||
Using the edpbuilder, you can set up a local IDP that comes with a Backstage instance containing the documentation.
|
||||
*How to set up a local IDP on a kind cluster is explained here: XXXXX*
|
||||
*[How to set up a local IDP on a kind cluster](docs/userguide/edpbuilder.md)*
|
||||
|
||||
3. **Forgejo Repository**
|
||||
If you prefer direct access, the content of our documentation is centrally defined and maintained within the docs folder of this repository.
|
||||
|
|
|
|||
|
|
@ -1,38 +1,38 @@
|
|||
## General information
|
||||
# Backstage
|
||||
|
||||
Backstage is a Platform Portal for building and managing internal developer tools, providing a unified interface for accessing various tools and resources within an organization.
|
||||
|
||||
### Key Features of Backstage as a Platform Portal
|
||||
1. **Tool Integration** <br>
|
||||
Backstage allows for the integration of various tools used in the development process, such as CI/CD, version control systems, monitoring, and others, into a single interface.
|
||||
|
||||
---
|
||||
|
||||
## Key Features of Backstage as a Platform Portal
|
||||
|
||||
### Tool Integration
|
||||
|
||||
Backstage allows for the integration of various tools used in the development process, such as CI/CD, version control systems, monitoring, and others, into a single interface.
|
||||
|
||||
### Service Management
|
||||
|
||||
2. **Service Management** <br>
|
||||
It offers the ability to register and manage services and microservices, as well as monitor their status and performance.
|
||||
|
||||
### Documentation and Learning Materials
|
||||
|
||||
3. **Documentation and Learning Materials** <br>
|
||||
Backstage includes capabilities for storing and organizing documentation, making it easier for developers to access information.
|
||||
|
||||
### Golden Paths
|
||||
|
||||
4. **Golden Paths** <br>
|
||||
Backstage supports the concept of "Golden Paths," enabling teams to follow recommended practices for development and tool usage.
|
||||
|
||||
### Modularity and Extensibility
|
||||
|
||||
5. **Modularity and Extensibility** <br>
|
||||
The platform allows for the creation of plugins, enabling users to customize and extend Backstage's functionality to fit their organization's needs.
|
||||
Backstage provides developers with centralized and convenient access to essential tools and resources, making it an effective solution for supporting Platform Engineering and developing an internal platform portal.
|
||||
|
||||
---
|
||||
|
||||
### 🔗 References
|
||||
* [Backstage Documentation & Community](https://backstage.io/)
|
||||
* [Backstage's GitHub](https://github.com/backstage/backstage)
|
||||
|
||||
|
||||
## How to use Backstage templates (Golden Paths) in EDP
|
||||
|
||||
1. **Open the Backstage Portal**
|
||||
## How to use Backstage templates (Golden Paths) in EDP
|
||||
|
||||
1. **Open the Backstage**
|
||||
LINK
|
||||
|
||||
2. **Navigate to "Create"**
|
||||
|
||||
|
|
@ -54,4 +54,11 @@ Backstage provides developers with centralized and convenient access to essentia
|
|||
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.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 🔗 References
|
||||
|
||||
* [Backstage Documentation & Community](https://backstage.io/)
|
||||
* [Backstage's GitHub](https://github.com/backstage/backstage)
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# Continuous Integration (CI) Workflow 🚀 - Franz
|
||||
# 🚀 Continuous Integration (CI) Workflow
|
||||
|
||||
Our repository includes a **Continuous Integration (CI) workflow** that runs automatically whenever changes are pushed to the codebase. By leveraging Forgejo and GitHub Actions, we ensure that every update is thoroughly validated, resulting in a reliable and error-free image being delivered to the Forgejo registry.
|
||||
|
||||
|
|
@ -6,30 +6,31 @@ Our repository includes a **Continuous Integration (CI) workflow** that runs aut
|
|||
|
||||
## How It Works
|
||||
|
||||
1. **Automatic Trigger on Code Changes**
|
||||
Each time you push a new commit or open a pull request, a CI workflow is initiated. You can monitor these runs by navigating to the Actions tab within your GitHub project.
|
||||
### Automatic Trigger on Code Changes
|
||||
|
||||
2. **Workflow Steps**
|
||||
Each time you push a new commit or open a pull request, a CI workflow is initiated. You can monitor these runs by navigating to the Actions tab within your GitHub project.
|
||||
|
||||
The CI pipeline consists of several predefined steps designed to ensure quality and security before publishing the final image:
|
||||
### Workflow Steps
|
||||
|
||||
- **📥 Checkout:**
|
||||
Retrieves the latest version of the repository to ensure the workflow is working with the most recent code.
|
||||
The CI pipeline consists of several predefined steps designed to ensure quality and security before publishing the final image:
|
||||
|
||||
- **📝 Linting (using xxx):**
|
||||
Analyzes the code for potential issues, formatting errors, or stylistic inconsistencies.
|
||||
- **📥 Checkout:**
|
||||
Retrieves the latest version of the repository to ensure the workflow is working with the most recent code.
|
||||
|
||||
- **🔑 Docker Login:**
|
||||
Authenticates with your Docker registry so that the newly built image can be pushed securely.
|
||||
- **📝 Linting (using xxx):**
|
||||
Analyzes the code for potential issues, formatting errors, or stylistic inconsistencies.
|
||||
|
||||
- **🔧 Build Application & Image:**
|
||||
Constructs the application and packages it into a Docker image.
|
||||
- **🔑 Docker Login:**
|
||||
Authenticates with your Docker registry so that the newly built image can be pushed securely.
|
||||
|
||||
- **🛡️ Vulnerability Scanning (using xxx):**
|
||||
Scans the final image for known security vulnerabilities, ensuring any issues are identified and addressed early on.
|
||||
- **🔧 Build Application & Image:**
|
||||
Constructs the application and packages it into a Docker image.
|
||||
|
||||
- **⬆️ Push Image to Registry:**
|
||||
Uploads the successfully built image to the Forgejo registry, making it available for deployment.
|
||||
- **🛡️ Vulnerability Scanning (using xxx):**
|
||||
Scans the final image for known security vulnerabilities, ensuring any issues are identified and addressed early on.
|
||||
|
||||
- **⬆️ Push Image to Registry:**
|
||||
Uploads the successfully built image to the Forgejo registry, making it available for deployment.
|
||||
|
||||
### Monitoring Workflow Progress and Logs
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue