Commit Graph

862 Commits

Author SHA1 Message Date
Patrik Oldsberg 40f0c33378 update backend Dockerfile to use config example and fix comment 2021-02-17 20:44:40 +01:00
Patrik Oldsberg d13aea9cd2 docs: add full docker deployment docs 2021-02-17 20:44:10 +01:00
Ben Lambert 37ff639dbd Merge pull request #4533 from ebarriosjr/fixing-github-apps-docs-yaml
Fixing GitHub apps docs yaml
2021-02-15 15:02:43 +01:00
ebarrios bdf5c24328 The apps entry in the yaml file need to be at the same level as the host, if it is not the app will not start and complain about it 2021-02-15 14:50:44 +01:00
Johan Haals 8b8e9d1e9a Export createExternalRouteRef and set id
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Co-authored-by: blam<ben@blam.sh>
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-02-15 11:59:32 +01:00
Fredrik Adelöw 68aba8682b fix a few little things in the entity docs 2021-02-15 10:21:17 +01:00
Esteban Barrios 8f53351a32 Rebase from master (#19)
* Fix client reference

* Fix CatalogClient reference in create-app too

* Move catalog-client dep to create-app

* Add catalog-client dep again..

* Use RequestOptions

* tsc

* Backwards compatible scaffolder

* Fix test

* Avoid importing core

* Use request options

* Increase code coverage

* Type those variables

* use the second mock

* Trying to make tests work on Github too

* Get clean yarn from master

* Only add authorization header if token exists

* Use request options

* Forward authorization header token

* Refactor to use context argument

* Allow the registration of optional locations via the catalog-client

* Make EntityRefLink a React.forwardRef in order to use it as root component in other components like ListItem

* Rework the user flow of the catalog-import plugin

* Update the create-app template

* Add luxon and remove moment

* Port moment to luxon

* Add change set

* Split the step label and content to be able to refactor the stepper from vertical to horizontal in the future

* Fix tsc, prettier and import issues

* Update .changeset/strange-olives-unite.md

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>

* Update plugins/auth-backend/src/identity/TokenFactory.ts

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>

* Change from minor to patch

* Update DatabaseKeyStore.ts

* feat: added a test for running a simple cypress server

* Add luxon and remove moment

* Port from moment to Luxon

* Add changeset

* Fixes following CR

* Rebased and reinstalled yarn.lock

* Changed to fromSQL

* Fix prettier formatting

* chore: reworking the lock file for the cypress deps

* chore: adding cypress.config

* chore: reworking some more examples

* chore: added some more simple stuff for e2e tests with cypress

* chore: reworking again

* chore: making cypress nice

* chore: added a sample test that works

* chore: reworking tests to use he cypress github-action instead

* chore: reconfigure Cypress run

* chore: don't install - we have deps

* chore: dump video recordings too

* chore: slimming down install script a little

* chore: make pretty

* chore: fixing syntax

* chore: fixing syntax again

* Align card elements with list

* Align card elements with List

* Add changeset

* Removed unused import

* chore: archive video footage with the correct path

* chore: fix lint warnings

* chore: fix prettier again

* chore: move files around for ease

* Added pattern for component name

* Add changeset

* stash: push to stash

* Return AboutCard title to group name

* Refactor children to use shared function

* TechDocs: Add visbility to migrate away from basic setup

* bugfix: [3310] Favoriting a component resets interface to your owned components

update changeset

remove unused import

fix changeset message

fix vale errors?

* Create utc DateTime object directly

* integration: update the gitlab config mandatory fields to match reality

* Resolve review comments

* Remove shadowed variables

* generateEntityDefinitions should return a PartialEntity

* Update roadmap with Backstage Community Sessions

* Make sure that SidebarItems are also active when on sub route

* Add whitespace around variable

* Add changeset

* Add word to dictionary

* Smater duration display

* Add changeset

* chore(deps-dev): bump @graphql-codegen/typescript from 1.18.1 to 1.20.2

Bumps [@graphql-codegen/typescript](https://github.com/dotansimha/graphql-code-generator/tree/HEAD/packages/plugins/typescript/typescript) from 1.18.1 to 1.20.2.
- [Release notes](https://github.com/dotansimha/graphql-code-generator/releases)
- [Changelog](https://github.com/dotansimha/graphql-code-generator/blob/master/packages/plugins/typescript/typescript/CHANGELOG.md)
- [Commits](https://github.com/dotansimha/graphql-code-generator/commits/@graphql-codegen/typescript@1.20.2/packages/plugins/typescript/typescript)

Signed-off-by: dependabot[bot] <support@github.com>

* chore: reworking folder structure to move cypress outside of the project

* chore: updating workflow to point at the right folder now

* chore: fixing cypress build

* microsite: Fix color contrast for pre tags

* Add package name to lockfile.ts error

* Create new-mangos-tap.md

* Changed changeset bump to be patch

* Pass registered Logger in ServiceBuilderImpl to requestLoggingHandler

`requestLoggingHandler` takes an optional `logger` parameter that it can use
to log incoming requests. The `ServiceBuilderImpl` was not passing  on this logger, if
set, to `requestLoggingHandler` middleware

* Add indices on columns referring location(id)

* Add changeset

* Catch catalog errors

* Add changeset

* Fixed parseUrl to output catalogPaths beginning with '/'

* Add configurable OAuth 2.0 scopes

- Add oauth2 config for optional scopes
- Document oauth2 config keys
- Add OAuth2 to demo app list of identity providers

* incorrectly added callbackUrl

* chore: added a simple readme to run some simple tests against a backstage instance

* chore(deps): bump @svgr/plugin-jsx from 5.4.0 to 5.5.0

Bumps [@svgr/plugin-jsx](https://github.com/gregberge/svgr) from 5.4.0 to 5.5.0.
- [Release notes](https://github.com/gregberge/svgr/releases)
- [Changelog](https://github.com/gregberge/svgr/blob/main/CHANGELOG.md)
- [Commits](https://github.com/gregberge/svgr/compare/v5.4.0...v5.5.0)

Signed-off-by: dependabot[bot] <support@github.com>

* chore(deps): bump @types/cors from 2.8.6 to 2.8.9

Bumps [@types/cors](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/cors) from 2.8.6 to 2.8.9.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/cors)

Signed-off-by: dependabot[bot] <support@github.com>

* fix: removing test e2e-test tsconfig.json file

* TechDocs: Preparers will take and return an etag for cache invalidation

* TechDocs: Implement etag based caching for url preparer

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>

* TechDocs: Implement etag based caching for git preparer

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>

* TechDocs: Warn when using legacy git preparer and dir preparer in backstage.io/techdocs-ref

Context: https://github.com/backstage/backstage/issues/4409

* TechDocs: Update tests for proper url preparer caching

* TechDocs: Deduplicate git clone for cache check

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>

* TechDocs: Add changesets for deprecation and proper caching

* TechDocs: Implement caching for dir preparer

* Update the changesets

* scaffolder-backend: remove auth-backend dependency

* catalog-client: rename ApiContext to CatalogRequestOptions + avoid export

* refactor existing usage of ApiContext

* techdocs: don't swallow errors other than NotModifiedError

* catalog-import: removed bonus code

* techdocs: meaningful logs when readTree starts

* Flatten the options of the CatalogImportPage

* inline optional id token auth headers

* Define relationship to software catalog and loose coupling by convention.

* Clarify intentions around bulk vs. incremental index management.

* Break apart backend plugins & clarify indexer/plugin relationship.

* update changeset bump levels

* [Search] documentation update (#4459)

* delete link to issue as it is closed

* replace usage of easy as its very subjective

* Update docs/features/search/architecture.md

Co-authored-by: Adam Harvey <adam.harvey@dxc.com>

* prettier....:

Co-authored-by: Adam Harvey <adam.harvey@dxc.com>

* Own it.

* scaffolder: include backstage identity token in requests

* review feedback tweaks

* docs/apis: update to use named plugin var

* sentry: update plugin instance export name

* clear other field when toggling reason

* changeset

* fix(pagerduty): use the luxon date library

* Don't pass default as a scope to OIDC providers

* docs(TechDocs): Add GitHub Actions CI example with AWS S3

* tech-radar: migrated to new composability API

* cost-insights: migrate to new composability API

* Changeset

* Fix line endings

* Prettier

* Remove unnecessary scopes from OIDC defaultApi

* Bump plugin-auth-backend to a minor change,
add documentation for fixing it

* Fix md syntax error

* Fix Vale spelling error

* Remove defaultScopes from OIDC api

* [ImgBot] Optimize images

/plugins/catalog-import/docs/catalog-import-screenshot.png -- 613.39kb -> 356.48kb (41.88%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>

* github/workflows: use lax config checks

* Use commented-out example value for scope

* feat(pagerduty): add changeset

* Apply suggestions from code review

Co-authored-by: Rémi Doreau <32459935+ayshiff@users.noreply.github.com>

* feat(catalog): add entity links card component

* update entity links changeset

* Fix prettier

* chore(deps-dev): bump @types/http-proxy from 1.17.4 to 1.17.5

Bumps [@types/http-proxy](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/http-proxy) from 1.17.4 to 1.17.5.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/http-proxy)

Signed-off-by: dependabot[bot] <support@github.com>

* Revert "Merge pull request #3953 from ayshiff/feature/techdocs-aws-sdkv3"

This reverts commit 1c7771871e, reversing
changes made to 65d5c8e6fe.

* Revert "Merge pull request #4035 from ayshiff/feature/catalog-backend-aws-sdk-v3"

This reverts commit 1df9134648, reversing
changes made to d45a510069.

* Add changeset

* feat: support custom app icons

* backend-common: implement UrlReader.search for the other providers too

* Remove changeset

* docs(TechDocs): Improvements to the CI example

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>

* fix(catalog): entity links incorrect wrapping

* Remove unused functions and luxon

* Removed old imports

* Fix broken links in documentation (#4418)

* Update IdentityApi.md

* Update docs/reference/utility-apis/IdentityApi.md

* Update docs/reference/utility-apis/IdentityApi.md

* ran yarn docgen

* Use JS Date instead of Datetime

* Add line

* Prettier fix

* Move parseDate function

* Version Packages

* chore: fix the create-app version

* Limit the props that are forwarded to the Link component in the EntityRefLink

* Use routed tabs to link to every settings page

* fix up yarn after release

* chore: add lockfile to words

* catalog-info: add links

* Export Select component from core

I saw the Select component on storybook and went
to use it but it seems it's not exported. Any chance
it could be exported?

* bug: filepath can be returned as undefined from `git-url-parse` let's default to empty

* chore: might as well do this for all parsing

* chore: changeset

* Add changeset for fixing requestLoggingHandler

* chore(deps-dev): bump @storybook/addon-actions from 6.1.11 to 6.1.17

Bumps [@storybook/addon-actions](https://github.com/storybookjs/storybook/tree/HEAD/addons/actions) from 6.1.11 to 6.1.17.
- [Release notes](https://github.com/storybookjs/storybook/releases)
- [Changelog](https://github.com/storybookjs/storybook/blob/next/CHANGELOG.md)
- [Commits](https://github.com/storybookjs/storybook/commits/v6.1.17/addons/actions)

Signed-off-by: dependabot[bot] <support@github.com>

* Port AboutCard

* Fix tests

* Revert EntityPage changes

* docs: Merge auth glossary with main glossary

* Remove the "Move repository" menu entry from the catalog page, as it's just a placeholder

It will be easy to bring it back later, but for now it just confuses users that it's not doing anything. It's also hard to remove for integrators.

* make the template cards conform to mui standard

Co-authored-by: Erik Larsson <erik.larsson@schibsted.com>
Co-authored-by: Dominik Henneke <dominik.henneke@sda-se.com>
Co-authored-by: Nils Streijffert <nstreijffert@spotify.com>
Co-authored-by: Nils Streijffert <nils.streijffert@gmail.com>
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
Co-authored-by: blam <ben@blam.sh>
Co-authored-by: Nir Gazit <nir.gzt@gmail.com>
Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
Co-authored-by: NHI TRAN <nhid@ntran.io>
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Co-authored-by: Oliver Sand <oliver.sand@sda-se.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Debajyoti Halder <rondebajyoti@gmail.com>
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
Co-authored-by: Gowind <petrovgovind@gmail.com>
Co-authored-by: Alan Crosswell <alan@columbia.edu>
Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Co-authored-by: Emma Indal <emma.indahl@gmail.com>
Co-authored-by: Ryan Vazquez <ryanv@spotify.com>
Co-authored-by: Ryan Vazquez <ryanmvazquez@gmail.com>
Co-authored-by: Remi <remi.d45@gmail.com>
Co-authored-by: Ryan Manny <rmanny@apptio.com>
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
Co-authored-by: Rémi Doreau <32459935+ayshiff@users.noreply.github.com>
Co-authored-by: Andrew Thauer <6507159+andrewthauer@users.noreply.github.com>
Co-authored-by: Joel Low <joel@joelsplace.sg>
Co-authored-by: Eric Peterson <iamEAP@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Iain Billett <iain@roadie.io>
2021-02-12 16:08:46 +01:00
Debajyoti Halder 14e39511c0 docs: Merge auth glossary with main glossary 2021-02-12 15:11:46 +05:30
Eric Peterson 174a63c466 Merge pull request #4472 from backstage/iameap/clarify-search-architecture
[Search] Clarify search architecture
2021-02-11 10:13:42 +01:00
Himanshu Mishra 14f04073ef Merge pull request #4475 from backstage/orkohunter/docs-techdocs-github-actions-ci-example 2021-02-11 09:54:34 +01:00
Emma Indal a473c6e7a1 Fix broken links in documentation (#4418)
* Update IdentityApi.md

* Update docs/reference/utility-apis/IdentityApi.md

* Update docs/reference/utility-apis/IdentityApi.md

* ran yarn docgen
2021-02-11 09:45:40 +01:00
Himanshu Mishra 7dc1e43c55 docs(TechDocs): Improvements to the CI example
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-02-11 09:28:08 +01:00
Himanshu Mishra d9ce84c732 Merge pull request #4426 from backstage/orkohunter/update-roadmap-with-community-sessions
Update roadmap about Backstage Community Sessions
2021-02-11 08:27:22 +01:00
Patrik Oldsberg afa453f744 Merge pull request #4465 from n2ygk/config_oauth_scope
Add configurable OAuth 2.0 scopes
2021-02-10 22:26:30 +01:00
Himanshu Mishra 0869aa161a docs(TechDocs): Add GitHub Actions CI example with AWS S3 2021-02-10 19:31:00 +01:00
Patrik Oldsberg 875471037e docs/apis: update to use named plugin var 2021-02-10 17:29:28 +01:00
Emma Indal 9c42fdf4ba [Search] documentation update (#4459)
* delete link to issue as it is closed

* replace usage of easy as its very subjective

* Update docs/features/search/architecture.md

Co-authored-by: Adam Harvey <adam.harvey@dxc.com>

* prettier....:

Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
2021-02-10 16:12:35 +01:00
Eric Peterson 5472e07abb Break apart backend plugins & clarify indexer/plugin relationship. 2021-02-10 14:38:31 +01:00
Eric Peterson 0c56a7f74f Clarify intentions around bulk vs. incremental index management. 2021-02-10 14:00:27 +01:00
Eric Peterson eef4423e7b Define relationship to software catalog and loose coupling by convention. 2021-02-10 13:58:49 +01:00
Himanshu Mishra 66944ec7bf TechDocs: Preparers will take and return an etag for cache invalidation 2021-02-10 11:01:18 +01:00
Alan Crosswell 07bafa248e Add configurable OAuth 2.0 scopes
- Add oauth2 config for optional scopes
- Document oauth2 config keys
- Add OAuth2 to demo app list of identity providers
2021-02-09 14:50:20 -05:00
Patrik Oldsberg 5643a6c630 Merge branch 'master' into welcome-clean 2021-02-09 14:38:08 +01:00
Emma Indal 98cdb20f01 update roadmap with milestones links (#4453) 2021-02-09 11:03:54 +01:00
Himanshu Mishra c6ca2431f9 Update roadmap with Backstage Community Sessions 2021-02-08 15:35:43 +01:00
Himanshu Mishra 43397061fd docs(TechDocs): docs/ is configurable by mkdocs.yml 2021-02-06 17:26:44 +01:00
Alex C. Bilimoria 0009804a84 Update docker run command in deployment-other.md 2021-02-04 09:58:41 -07:00
Adam Harvey 98da973e1e Use different example name 2021-02-03 15:40:13 -05:00
Adam Harvey a19021a7c1 Remove reference to the welcome plugin 2021-02-03 15:39:24 -05:00
Himanshu Mishra 29e269d920 TechDocs: Remove traces of requestUrl/storageUrl from docs 2021-02-02 13:52:45 +01:00
Parth Shandilya e44925723e TechDocs: Make requestUrl and storageUrl optional configs by using discovery APIs
closes #3715

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-02-02 13:51:04 +01:00
Fredrik Adelöw 246c9c6edc Update docs/plugins/observability.md
Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
2021-02-02 11:07:51 +01:00
Fredrik Adelöw 77fe4ef3cd docs: add a miniature article about observability 2021-02-01 17:09:03 +01:00
Himanshu Mishra 79fd002145 Merge pull request #4335 from backstage/orkohunter/docs-techdocs-migrate-basic-to-recommended 2021-02-01 15:16:16 +01:00
Fredrik Adelöw 1d0ee04721 Merge pull request #4334 from backstage/blam/docs-update
docs(software-templates): updating docs for required vars in software-templates
2021-02-01 15:04:26 +01:00
Ben Lambert c0a5e2710a Update docs/features/software-templates/index.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-02-01 13:41:20 +01:00
Ben Lambert 5d42c04218 Update docs/features/software-templates/index.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-02-01 13:41:14 +01:00
Himanshu Mishra ae508116d9 docs: TechDocs revamp techdocs architecture page
Remove/Update features which have been implemented.
2021-02-01 12:02:44 +01:00
Himanshu Mishra f27b40e6af docs: TechDocs HOW TO migrate from basic to recommended approach 2021-02-01 11:42:23 +01:00
blam 978d4ab5a2 docs(software-templates): updating docs for storePath 2021-02-01 10:54:53 +01:00
Patrik Oldsberg 58a28f0b87 docs: update plugin create and reference docs for top-level routable extensions 2021-01-31 21:39:05 +01:00
Himanshu Mishra 8eb862c58e Merge pull request #4017 from viavarejo/feature/techdocs-azure-storage 2021-01-31 16:03:24 +01:00
Adam Harvey a14d702a7d Clarify create plugin step 2021-01-29 14:20:55 -05:00
Adam Harvey baf5615b51 Clarifications 2021-01-29 14:17:26 -05:00
Adam Harvey e763dcf8c4 Fix Backstage case 2021-01-29 14:17:09 -05:00
Adam Harvey 357c1f1e5f Clarify link and Backstage case 2021-01-29 14:16:26 -05:00
Patrik Oldsberg 750988b3d6 Merge pull request #4293 from backstage/rugvip/autoauth
core: add single provider mode for SignInPage, with automatic sign-in
2021-01-29 17:41:32 +01:00
Himanshu Mishra 26bb405108 Merge pull request #4287 from backstage/orkohunter/dir-preparer-uses-url-reader 2021-01-29 09:56:55 +01:00
Himanshu Mishra 4f32647f00 TechDocs: docs - Add reference link to techdocs-ref annotation 2021-01-28 20:20:19 +01:00
vitorgrenzel ee271bf86e feat(docs): update Azure Blob Storage 2021-01-28 16:17:30 -03:00