question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Core feature: is it a Software Catalog or a Service Catalog?

See original GitHub issue

Feature Suggestion

In terms of the Backstage documentation, there’s an entire section of the Core Features labeled as “Software Catalog” inferring that’s a key feature. However, opening that section, everywhere it’s actually described instead as a “Service Catalog”. And within the product itself, it also refers to Services of course.

The reason for this feature request is to help define: Is Backstage’s core feature a “Service Catalog” or a “Software Catalog”?

image

Inside of the documentation, there are 25 references to “software catalog” and 35 to “service catalog”. I wonder if an ADR would be appropriate here, but in discussing with my team I’m not sure if it’s really one or the other. Service of course drives to support of microservices, though some companies won’t be using such an approach. Software is more generic, and more understood in the industry so I’m leaning that it seems it should be “Software Catalog”.

As I pitch the product with my squad, getting alignment for me would be key.

Based on any discussions, happy to file a change to update it but wanted to drive the alignment.

Possible Implementation

Update to the documentation sidebar nav, as well as some tweaks to the content. Also would involve some minor code changes where, for example on the homepage, it says “Organization Name Service Catalog”.

Context

/mnt/c/github/backstage/docs(master)*$ grep -i -R "software catalog" | wc -l
25
/mnt/c/github/backstage/docs(master)*$ grep -i -R "service catalog" | wc -l
32

Specifically, the sidebar is defined as:

"Core Features": [
      {
        "type": "subcategory",
        "label": "Software Catalog",
        "ids": [
          "features/software-catalog/software-catalog-overview",
          "features/software-catalog/installation",
          "features/software-catalog/configuration",
          "features/software-catalog/system-model",
          "features/software-catalog/descriptor-format",
          "features/software-catalog/references",
          "features/software-catalog/well-known-annotations",
          "features/software-catalog/extending-the-model",
          "features/software-catalog/external-integrations",
          "features/software-catalog/software-catalog-api"
        ]
      },

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:7 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
jvalerianocommented, Jan 15, 2021

Hi in the model documentation https://backstage.io/docs/features/software-catalog/descriptor-format#kind-system Backstage has many entities but none of them is Software or Service. As it is today is a Component Catalog. Regards,

0reactions
stale[bot]commented, Mar 29, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Core feature: is it a Software Catalog or a Service Catalog?
However, opening that section, everywhere it's actually described instead as a "Service Catalog". And within the product itself, it also refers ...
Read more >
What is service catalog? ITSM catalog examples & templates
ITIL defines a service catalog as a centralized database of accurate information about active IT service offerings, and a subset of the IT...
Read more >
The Essential Guide to Creating an IT Service Catalog
The IT service catalog is a subset of the full service portfolio, and lists active services that are currently being offered, leaving out...
Read more >
Business Service Catalog vs Technical ... - BMC Software
The technical service catalog, along with configuration information, outlines how business and technical services and processes work together ...
Read more >
The Differences Between a Service Catalog, Internal ... - DZone
A service catalog gives increased visibility of resources and who is responsible for them, preventing duplicated effort and reducing countless “ ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found