paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Create doc-landing-page.md using html for table (#30884)

Browse Source 
* Create doc-landing-page.md using html for table

HTML is used for the tables in this new doc landing page.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update doc-landing-page.md

Changed id of documentation and corrected some spelling mistakes.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update doc-landing-page.md rearrange table and add links

Incorporated PR suggestions. Added trial links in two different flavors to see which way works.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update doc-landing-page.md fix prettier spacing

Changed all indents to 2 spaces to try to fix prettier errors.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update doc-landing-page.md changed top to "top" for valign attribute

Changed valign=top to valign="top" to see if it fixes prettier errors.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update doc-landing-page.md changes double quotes to single quotes

Changed all double quotes to single quotes and removed all hrefs to see if I can get the file to pass the prettier check.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update doc-landing-page.md fix prettier errors

Hopefully, fixed prettier errors by removing extra lines.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update doc-landing-page.md try to fix prettier errors

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update doc-landing-page.md added links for understanding, using, and administering backstage

Added links for each of the bullet points in "Understanding Backstage", "Using Backstage" and "Backstage Administration".

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update doc-landing-page.md added remainder of links

Added links for additional features, plugin development, references, and contributing to Backstage. Changed "Scaffolder" bullet to "Software Templates (aka Scaffolder)"

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update doc-landing-page.md to remove Update a Component

The document explaining how to update a component has not yet been written. So removing this bullet until the updating documentation exists.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update docusaurus.config.ts for new doc landing page

Changed landing page from What is Backstage to the new doc-landing-page.md file.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update doc-landing-page.md added new technical overview

Added a bullet under Learn about Backstage for the new Technical Overview.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Apply suggestion from @aramissennyeydd

Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>

---------

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
Co-authored-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
This commit is contained in:
milliehartnt123
2025-10-08 11:28:08 -04:00
committed by GitHub
parent 2f3ea4f374
commit 019f3a64aa
1 changed files with 109 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/landing-page/doc-landing-page.md
+109
View File
@@ -0,0 +1,109 @@
---
id: doc-landing-page
title: Documentation
description: Documentation landing page.
---
## 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><br><br>
<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><br>
<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><a href='https://backstage.io/docs/getting-started/register-a-component'>Registering a Component</a></li>
<li><a href='https://backstage.io/docs/getting-started/create-a-component'>Creating a Component</a></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>
<li><a href='https://backstage.io/docs/features/techdocs/'>TechDocs - a docs-like-code solution</a></li>
</ul>
</td>
<td valign='top'><i>Configure, Deploy, & Upgrade.</i><br><br>
<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><br><br>
<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></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><br><br>
<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><br>
<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/docs/reference/'>Package Index</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><br>
<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>