Skip to content

Latest commit

 

History

History
58 lines (30 loc) · 4.66 KB

index.md

File metadata and controls

58 lines (30 loc) · 4.66 KB
Raw

Shell Backstage User Guide

This user guide provides instructions for running and using an existing instance of Shell Backstage. Backstage is a platform for building developer portals, with various features to streamline your software development workflow and enhance collaboration.

Getting Started

To begin using the Shell Backstage App, you need to install the required dependencies and start the application. Use the commands listed in the scripts section of the package.json file to manage your application, such as building, starting, and running tests.

Navigating Backstage

Backstage provides a user-friendly interface to navigate and explore various features. Here's an overview of the key components:

  • Navigation Bar: Located at the top of the screen, it provides access to different sections of Backstage, such as Catalog, TechDocs, and more.

  • Catalog: The Catalog section lists the available components, services, and resources. You can browse and search for specific items using filters and facets.

  • TechDocs: The TechDocs section provides access to technical documentation, including guides, APIs, and other relevant resources.

  • Plugins: Backstage supports various plugins that enhance its functionality. Explore the available plugins and their features to make the most of your Shell Backstage instance.

  • GitHub Actions Plugin: The GitHub Actions plugin integrates with your GitHub repositories and allows you to view and manage workflows directly from Backstage. You can access and monitor the status of your workflows, review logs, and trigger manual workflow runs.

  • GitHub Pull Request Plugin: With the GitHub Pull Request plugin, you can easily track and manage pull requests associated with your repositories. It provides a unified interface to view and interact with pull requests, leave comments, and perform code reviews.

  • GitHub Insights Plugin: The GitHub Insights plugin offers powerful analytics and metrics for your GitHub repositories. It provides detailed information on code quality, repository activity, and collaboration patterns. Use the Insights section to gain valuable insights into your software development process.

  • API Page: The API Page allows you to document and explore APIs within your organization. It provides a centralized location to view API documentation, endpoints, request/response examples, and related information. You can use this feature to document and share APIs across your teams.

  • Create New Entity Page: The Create New Entity page is used to create new entities within Backstage. An entity represents a component, service, or resource that can be cataloged and managed within the system. This page provides a form-based interface to specify the details of the entity and add it to the catalog.

Feel free to explore these features in Backstage and leverage them to enhance your software development and collaboration workflows.

Using Backstage Features

Backstage offers a range of features to streamline your development workflow. Here are some commonly used features:

  • Component Exploration: Use the Catalog section to explore components and services available in your organization. You can view details, documentation, and related information for each component.

  • Documentation Access: In the TechDocs section, access technical documentation, API references, and other relevant resources for your organization's projects.

  • Collaboration and Communication: Utilize the built-in collaboration features, such as commenting and discussions, to communicate with other team members and stakeholders.

  • Integration with Version Control Systems: Backstage integrates with popular version control systems like Git, allowing you to view and manage repositories, branches, and pull requests.

Troubleshooting

If you encounter any issues while using Backstage, consider the following steps:

  • Check Documentation: Consult the official Backstage documentation for troubleshooting guides and common issues.

  • Contact Support: If you require further assistance, reach out to your organization's support channels or the designated Backstage administrators.

Additional Resources

For more information and detailed documentation, refer to the following resources: