DevFW-CICD/edp-doc
17
0
Fork 1
Code Issues Pull requests 2 Projects Releases Packages Wiki Activity Actions

Added backstage documentation

Browse source
This commit is contained in:
evdo 2024-12-17 21:27:27 +01:00
parent a6dd5fe8a8
commit b8908db873
1 changed files with 57 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
docs/userguide/backstage.md
View file

@ -1 +1,57 @@
evgenii
## General information
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.
2. **Service Management** <br>
It offers the ability to register and manage services and microservices, as well as monitor their status and performance.
3. **Documentation and Learning Materials** <br>
Backstage includes capabilities for storing and organizing documentation, making it easier for developers to access information.
4. **Golden Paths** <br>
Backstage supports the concept of "Golden Paths," enabling teams to follow recommended practices for development and tool usage.
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**
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)
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**
Enter the necessary information that the template requires to create the component.
![step 2](../ressources/2.png)
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)