Back to Backstage

Documentation

docs/landing-page/doc-landing-page.md

1.51.0-next.27.1 KB
Original Source

Understand, try, and administer Backstage

<table> <tr> <th>Understand Backstage</th> <th>Try Backstage</th> <th>Administration</th> <th>Additional Features</th> </tr> <tr> <td valign='top'><i>Learn about Backstage.</i>
  <ul>
    <li><a href='https://backstage.io/docs/overview/what-is-backstage'>What is Backstage?</a></li>
    <li><a href='https://backstage.io/docs/overview/technical-overview'>Technical Overview</a></li>
    <li><a href='https://backstage.io/docs/overview/architecture-overview'>Architecture overview</a></li> 
    <li><a href='https://backstage.io/docs/plugins/'>Introduction to Plugins</a></li>
    <li><a href='https://backstage.io/docs/features/software-catalog/'>Software Catalog Overview</a></li>
    <li><a href='https://backstage.io/docs/features/software-catalog/system-model'>System Model</a></li>
    <li><a href='https://backstage.io/docs/auth/'>Authentication in Backstage</a></li>
    <li><a href='https://backstage.io/docs/backend-system/'>Backend System Overview</a></li>
    <li><a href='https://backstage.io/docs/frontend-system/architecture/index'>New Frontend System Overview</a></li> 
    <li><a href='https://backstage.io/docs/overview/threat-model'>Security & Threat Model</a></li>
    <li><a href='https://backstage.io/docs/overview/versioning-policy'>Release & Versioning Policy</a></li>
  </ul>
</td>
<td valign='top'><i>Build a customizable Backstage app.</i>

  <ul>
    <li><a href='https://backstage.io/docs/getting-started/'>Create your Backstage App</a></li>
    <li><a href='https://backstage.io/docs/getting-started/logging-in'>Logging into Backstage</a></li>
    <li>Using the Catalog
      <ul>
        <li><a href='https://backstage.io/docs/getting-started/viewing-catalog'>Viewing the Catalog</a></li>
        <li><a href='https://backstage.io/docs/getting-started/view-what-you-own'>Viewing what you own</a></li>
        <li><a href='https://backstage.io/docs/getting-started/viewing-entity-relationships'>Viewing entity relationships</a></li>
        <li><a href='https://backstage.io/docs/getting-started/filter-catalog'>Filtering the Catalog</a></li>
      </ul>
    </li>
    <li>Managing Components
      <ul>
        <li><a href='https://backstage.io/docs/getting-started/register-a-component'>Register</a></li>
        <li><a href='https://backstage.io/docs/getting-started/create-a-component'>Create</a></li>
        <li><a href='https://backstage.io/docs/getting-started/update-a-component'>Update</a></li>
        <li><a href='https://backstage.io/docs/getting-started/unregister-delete-component'>Unregister/delete</a></li>
      </ul>
    </li>
    <li><a href='https://backstage.io/docs/features/software-templates/configuration'>Configuring a Software Template</a></li>
    <li><a href='https://backstage.io/docs/features/software-templates/adding-templates'>Creating a Software Template</a></li>
    <li><a href='https://backstage.io/docs/features/kubernetes/'>Check health of services with Kubernetes</a></li>
    <li><a href='https://backstage.io/docs/tooling/cli/overview/'>Backstage CLI</a></li>
  </ul>           
</td> 
<td valign='top'><i>Configure, Deploy, & Upgrade.</i>


  <ul>
    <li><a href='https://backstage.io/docs/getting-started/config/authentication'>Setup Authentication</a></li>
    <li><a href='https://backstage.io/docs/getting-started/config/database'>Configure a Database</a></li>
    <li><a href='https://backstage.io/docs/getting-started/configure-app-with-plugins'>Add plugins to expand functionality</a></li>
    <li><a href='https://backstage.io/docs/notifications/'>Install Notification System</a></li>
    <li><a href='https://backstage.io/docs/permissions/overview'>Setup permissions</a></li>
    <li><a href='https://backstage.io/docs/getting-started/app-custom-theme'>Customize the look-and-feel</a></li>
    <li><a href='https://backstage.io/docs/getting-started/homepage'>Customize Backstage homepage</a></li>
    <li><a href='https://backstage.io/docs/integrations/'>Integrate with external providers to read or publish data</a></li>
    <li><a href='https://backstage.io/docs/deployment/'>Deploy Backstage to Production</a></li>
  </ul>
</td>
<td valign='top'><i>Additional Backstage Features</i>


  <ul>
    <li><a href='https://backstage.io/docs/features/search/'>Search</a></li>
    <li><a href='https://backstage.io/docs/features/software-catalog/'>Software Catalog</a></li>
    <li><a href='https://backstage.io/docs/features/software-templates/'>Software Templates (aka Scaffolder)</a></li>
    <li><a href='https://backstage.io/docs/features/techdocs/'>TechDocs - a docs-like-code solution</a></li>
  </ul>
</td>
</tr> </table>

Plugin Development, references, and how to contribute

<table> <tr> <th>Plugin Development</th> <th>References</th> <th>Contribute to Backstage</th> </tr> <tr> <td valign='top'><i>Creating and Configuring Plugins</i>
  <ul>
    <li><a href='https://backstage.io/docs/plugins/'>Introduction to Plugins</a></li>
    <li><a href='https://backstage.io/docs/plugins/create-a-plugin'>Create a Backstage Plugin</a></li>
    <li><a href='https://backstage.io/docs/plugins/plugin-development'>Plugin Development</a></li>
    <li><a href='https://backstage.io/docs/plugins/integrating-plugin-into-software-catalog'>Integrating a Plugin into the Software Catalog</a></li>
    <li><a href='https://backstage.io/docs/plugins/integrating-search-into-plugins'>Integrating Search into a Plugin</a></li>
    <li><a href='https://backstage.io/docs/conf/defining'>Defining Configuration for your Plugin</a></li>
    <li><a href='https://backstage.io/docs/permissions/plugin-authors/01-setup'>Tutorial: using Permissions in your Plugin</a></li>
    <li><a href='https://backstage.io/docs/plugins/analytics'>Plugin Analytics</a></li>
  </ul>
</td>
<td valign='top'><i>Glossary, FAQ, and other reference material.</i>

  <ul>
    <li><a href='https://backstage.io/docs/references/glossary'>Glossary</a></li>
    <li><a href='https://backstage.io/docs/dls/design'>Designing for Backstage</a></li>
    <li><a href='https://backstage.io/docs/architecture-decisions/'>Architecture Decision Records (ADRs)</a></li>
    <li><a href='https://backstage.io/docs/api/deprecations'>Deprecations</a></li>
    <li><a href='https://backstage.io/docs/api/utility-apis'>Utility APIs</a></li>
    <li><a href='https://backstage.io/api/stable/'>API References</a></li>
    <li><a href='https://backstage.io/docs/faq/'>FAQ</a></li>
  </ul>
</td>
<td valign='top'><i>Contributions are welcome and greatly appreciated!</i>

  <ul>
    <li><a href='https://backstage.io/docs/contribute/'>Contributor's Guide</a></li>
    <li><a href='https://backstage.io/docs/contribute/getting-involved'>Getting Involved</a></li>
    <li><a href='https://backstage.io/docs/contribute/project-structure'>Backstage Project Structure</a></li>
  </ul>
</td>
</tr> </table>