backstage

1
app:
2
  experimental:
3
    packages: 'all' # ✨
4

5
  routes:
6
    bindings:
7
      catalog.viewTechDoc: techdocs.docRoot
8
      catalog.createComponent: catalog-import.importPage
9
      org.catalogIndex: catalog.catalogIndex
10

11
  extensions:
12
    # - apis.plugin.graphiql.browse.gitlab: true
13
    - graphiql-endpoint:graphiql/gitlab: true
14

15
    # Entity page cards
16
    - entity-card:catalog/about
17
    - entity-card:catalog/labels
18
    - entity-card:catalog/links:
19
        config:
20
          filter: kind:component has:links
21
    - entity-card:linguist/languages
22
    - entity-card:catalog-graph/relations:
23
        config:
24
          height: 300
25
    - entity-card:api-docs/has-apis
26
    - entity-card:api-docs/consumed-apis
27
    - entity-card:api-docs/provided-apis
28
    - entity-card:api-docs/providing-components
29
    - entity-card:api-docs/consuming-components
30

31
    # - entity-card:azure-devops/readme
32
    # Entity page content
33
    - entity-content:api-docs/definition
34
    - entity-content:api-docs/apis
35
    - entity-content:techdocs
36
    # - entity-content:azure-devops/pipelines
37
    # - entity-content:azure-devops/pull-requests
38
    # - entity-content:azure-devops/git-tags
39

40
    # Org Plugin
41
    - entity-card:org/group-profile
42
    - entity-card:org/members-list
43
    - entity-card:org/ownership
44
    - entity-card:org/user-profile
45

46
  # scmAuthExtension: >-
47
  #   createScmAuthExtension({
48
  #     id: 'apis.scmAuth.addons.ghe',
49
  #     factory({ bind }) {
50
  #       bind.scmAuthAddon({
51
  #         baseUrl: 'https://github.spotify.net',
52
  #         api: githubAuthApiRef,
53
  #       })
54
  #     }
55
  #   })
56

57
  # externalRouteRefs:
58
  # bind(catalogPlugin.externalRoutes, {
59
  #   createComponent: scaffolderPlugin.routes.root,
60
  #   viewTechDoc: techdocsPlugin.routes.docRoot,
61
  #   createFromTemplate: scaffolderPlugin.routes.selectedTemplate,
62
  # });
63
  # bind(apiDocsPlugin.externalRoutes, {
64
  #   registerApi: catalogImportPlugin.routes.importPage,
65
  # });
66
  # bind(scaffolderPlugin.externalRoutes, {
67
  #   registerComponent: catalogImportPlugin.routes.importPage,
68
  #   viewTechDoc: techdocsPlugin.routes.docRoot,
69
  # });
70
  # bind(orgPlugin.externalRoutes, {
71
  #   catalogIndex: catalogPlugin.routes.catalogIndex,
72
  # });
73

74
  # extensions:
75
  # - plugin.catalog:
76
  #     config:
77
  #       externalRoutes:
78
  #         createComponent: plugin.scaffolder.page
79
  #         viewTechDoc: plugin.techdocs.docRootPage
80
  #         createFromTemplate: plugin.scaffolder.templatePage
81
  # - graphiql.page:
82
  #     config:
83
  #       path: /
84
  # - apis.auth.providers.github:
85
  #     config:
86
  #       provider: ghe
87

88
  # - core.signInPage:
89
  #     props:
90
  #       provider:
91
  #         id: google
92
  #         title: Google
93
  #         message: Sign In using Google
94
  #         apiRef: googleAuthApiRef # ???
95

96
  # - core.nav:
97
  #     config:
98
  #       logo: assets/logo.png
99
  #       layout:
100
  #       - label: Search
101
  #         icon: search
102
  #         to: /search
103
  #         items:
104
  #         - point: search
105
  #       - type: divider
106
  #       - label: Menu
107
  #         icon: menu
108
  #         items:
109
  #         - label: Home
110
  #           icon: home
111
  #           to: /catalog
112
  #         - label: Create...
113
  #           icon: create
114
  #           to: /create
115
  #         - type: divider
116
  #         - type: scroll-wrapper
117
  #           items:
118
  #           - label: Tech Radar
119
  #             icon: map
120
  #             to: /tech-radar
121
  #           - label: GraphiQL
122
  #             icon: graphiql
123
  #             to: /graphiql
124
  #         - type: divider
125
  #         - point: shortcuts
126
  #       - type: space
127
  #       - type: divider
128
  #       - label: Settings
129
  #         icon: avatar
130
  #         to: /settings
131
  #         items:
132
  #         - point: settings
133
  # - core.nav/search: '@backstage/plugin-search#SidebarSearchModal'
134
  # - core.nav/shortcuts:
135
  #     use: '@backstage/plugin-shortcuts#Shortcuts'
136
  #     config:
137
  #       allowExternalLinks: true
138
  # - core.nav/settings: '@backstage/plugin-user-settings#SidebarSettings'
139

140
  # - core.pages.index:
141
  #     at:
142
  #       point: core.routes
143
  #       config:
144
  #         path: /
145
  #     use: 'react-router-dom#Navigate'
146
  #     config:
147
  #       to: /catalog
148

149
  # - scaffolder.page:
150
  #     config:
151
  #       groups:
152
  #       - title: Recommended
153
  #         filter:
154
  #           entity.metadata.tags: recommended
155
  # - scaffolder.page/fields: '@backstage/plugin-scaffolder#LowerCaseValuePickerFieldExtension'
156
  # - scaffolder.page/layout: '@backstage/plugin-scaffolder#TwoColumnLayout'
157

158
  # - search.page/content: 'app#customSearchPage' # custom search page from somewhere
159

160
  # - user-settings.page.routes.advanced:
161
  #     at:
162
  #       point: user-settings.page/routes
163
  #       config:
164
  #         title: Advanced
165
  #         path: /advanced
166
  #       use: '@backstage/plugin-user-settings#AdvancedSettings'
167

168
  # - entity.card.orphanWarning
169
  # - entity.card.processingErrors
170
  # - entity.card.about
171
  # - entity.card.catalogGraph
172
  # - entity.card.pagerDuty
173
  # - entity.card.links
174
  # - entity.card.labels
175
  # - entity.card.githubInsightsLanguages
176
  # - entity.card.githubInsightsReleases
177
  # - entity.card.githubInsightsReadme:
178
  #     config:
179
  #       maxHeight: 350 # Throwing this config in to have an example, but in practice rely on default
180
  # - entity.card.subcomponentsCard
181
  # - entity.card.userProfile
182
  # - entity.card.ownership
183
  # - entity.card.likeDislikeRatings
184
  # - entity.content.dependsOnComponents
185
  # - entity.content.codeInsights
186
  # - entity.content.todo
187
  # - entity.content.feedbackResponse
188