Commit Graph

41 Commits

Author SHA1 Message Date
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
Adam Harvey 98da973e1e Use different example name 2021-02-03 15:40:13 -05:00
Patrik Oldsberg 58a28f0b87 docs: update plugin create and reference docs for top-level routable extensions 2021-01-31 21:39:05 +01:00
Adam Harvey e763dcf8c4 Fix Backstage case 2021-01-29 14:17:09 -05:00
Patrik Oldsberg a187b8ad0a core-api: remove deprecated registerRoute and deprecate addRoute 2021-01-19 23:50:38 +01:00
Dominik Henneke 192b0b70a8 Update vale vocabulary to unify company and product names 2021-01-12 13:52:58 +01:00
Askar a6a2ca6204 remove React's FC type from codebase (#3527)
* WIP-packages: remove React's FC type from codebase

* remove FC from other directories

* fix build failures

* add types to required packages
2020-12-10 11:23:29 +01:00
Adam Harvey 303c5ea171 chore(sentry,welcome): Refactor route registration to remove deprecating code (#3493)
* Refactor route registration

* Reference route RFC

* Refactor example code to remove deprecated call

* Add changeset

* Return feature flag
2020-11-30 09:04:13 +01:00
Patrik Oldsberg af141c0766 rewrite repo location urls 2020-11-03 11:03:49 +01:00
Patrik Oldsberg 9e269db39b Merge pull request #3150 from spotify/rugvip/docs
docgen: add support for picking up the type from the declaration instead of initialization
2020-11-02 16:57:32 +01:00
Patrik Oldsberg bb400beea0 docs: regenerate api reference docs 2020-11-02 16:34:02 +01:00
Patrik Oldsberg b1b3f094f1 docs: tweak feature-flags docs 2020-10-29 15:51:54 +01:00
Patrik Oldsberg 471b15aa18 docs: update feature flag docs 2020-10-28 22:10:23 +01:00
Patrik Oldsberg e64fc519b8 core-api: remove FeatureFlagName type 2020-10-28 16:49:09 +01:00
Mayursinh Sarvaiya 5c6a0356c0 feat: TechDocs - Add vale linter to check words quality in md files. (#2631)
* fix(docs): typos which were reflacted from vale linter's command

* feat: Implement Vale linter (#2031)
Initialize .vale.ini file
Add 'lint:docs' script to package.json, to lint all md files except the ones which are located in node_modules
Generate 'vocab.txt' by using command 'yarn run lint:docs' | grep -o ''[a-z A-Z]*'' | grep -o '[a-z A-Z]*' | sort | uniq > .github/styles/vocab.txt
Add steps to github workflow 'master' to check docs quality

* chore: Separate workflow for quality checking

* chore: Added 'shx' dev dependency to support grep command in cross platform

* feat: Add script to operate same quality check process on different platform

* ignore: remove lint:docs from lint-stages which was added for experiment purpose

* fix: check-all-files on push event & check-changed-files on pull_request event

* chore(CI): triggle workflow only when there is any updates in .md file(s) on pull request

* fix: use spawnSync to solve 'The command line is too long.' error

* fix: github workflow syntax

* fix: prettier error

* chore: add vale command directly to lint-staged

* chore: use shebang for easy access

* fix: windows script issue & remove shebang

* chore: Add shebang flag

* chore: better error message related to vale

* chore: mention vale linter in documentation

* fix: spelling errors & add keywords to vocab.txt
2020-10-02 07:20:47 +02:00
Patrik Oldsberg d994ed61a2 docs: regenerate api reference docs 2020-09-22 11:42:21 +02:00
Rajiv Ranjan Singh def4032351 added description header field 2020-09-16 21:47:19 +05:30
Patrik Oldsberg c84bfb5ca6 docs: sync api reference docs 2020-09-09 10:45:56 +02:00
Stefan Ålund a8edb19f61 [Docs] Various fixes (#2136)
* [Docs] Various fixes

* More fixes

* Fix ADRs

* Typo
2020-08-27 13:27:22 +02:00
Stefan Ålund c6c3c94c18 Camelcase GitHub and GitLab (#2034)
* Camelcase GitHub and GitLab

* GitLab

* Code GitLab

* GitHub in code

* Fix auth naming

* Update docs/features/software-templates/adding-templates.md

Co-authored-by: Raghunandan Balachandran <soapraj@gmail.com>

* Update docs/features/software-templates/extending/create-your-own-preparer.md

Co-authored-by: Raghunandan Balachandran <soapraj@gmail.com>

Co-authored-by: Raghunandan Balachandran <soapraj@gmail.com>
2020-08-21 14:48:16 +02:00
Ivan Shmidt 882728ae1d feat: the whole docs structure
Co-authored-by: Raghunandan Balachandran <meetraghu28@gmail.com>
Co-authored-by: Ben Lambert <ben@blam.sh>
2020-08-12 15:20:20 +02:00
Chris Simmons 1c559bcc90 Enable override of sidebar selected indicator color when using createTheme (#1880)
* refactored sidebar palette types + updated default themes

* use @backstage/theme and new selectedIndicatorColor palette property

* fixed sidebar to use refactored backgroundColor property

* simplified property names based on feedback

* renamed sidebar to navigation in palette

* updated AppThemeApi docs with PaletteAdditions changes
2020-08-11 08:16:46 +02:00
Patrik Oldsberg b5b976270d docs: regenerated utility api reference docs 2020-08-08 12:09:00 +02:00
Patrik Oldsberg c75beb460d docs: regenerate api reference docs 2020-07-19 14:27:36 +02:00
Patrik Oldsberg 8cd5fb5e7c docs: generate utility api reference 2020-07-19 14:27:34 +02:00
Stefan Ålund 20f030ab87 [Docs] Fixed some more links (#1648) 2020-07-15 15:59:34 +02:00
Stefan Ålund 8ec6ed5170 Documentation skeleton (#1617)
* Documentation skeleton

* Added ADR list and more

* rm material theme

* Update mkdocs.yml

* Add docs TOC

* Work for plain MD and mkdocs

* Update mkdocs.yml

* Restructuring

* Added roadmap

* Add reference APIs

* move publishing
2020-07-15 08:57:25 +02:00
Patrik Oldsberg a633dce818 docs: format with prettier (#1218) 2020-06-09 19:50:41 +02:00
Ivan Shmidt af56473342 NavLink->Link, NavButton->Button, remove redirects for now 2020-06-04 00:03:34 +02:00
Ivan Shmidt 0a13a11f7b Enforcing RouteRefs more: docs, templates, types 2020-06-03 16:40:13 +02:00
Bilawal Hameed 8fce6e90b5 fix(feature-flags): corrected docs to instantiate FeatureFlags 2020-04-18 16:55:42 +02:00
Bilawal Hameed f1acc3e0bc Fix code sample 2020-03-31 23:04:56 +02:00
Bilawal Hameed 70252160e5 [core] change FeatureFlagState to {On,Off} 2020-03-30 12:29:54 +02:00
Bilawal Hameed 64a14b2191 [core/apis] adapted to build on existing data structures 2020-03-30 12:07:38 +02:00
Bilawal Hameed a8f304dbfb [docs/reference] updated to reflect React Hooks changes 2020-03-30 12:07:38 +02:00
Bilawal Hameed 92d091dec8 [core/apis] consolidated methods to get/set 2020-03-30 12:07:38 +02:00
Bilawal Hameed 71072da838 [docs] updated to reflect both useApi and FeatureFlags object 2020-03-30 12:07:38 +02:00
Bilawal Hameed 817c476050 [docs] updated with typescript definitions + code sample 2020-03-30 12:07:37 +02:00
Bilawal Hameed 8145ba8b94 [docs] added skeleton 2020-03-30 12:07:37 +02:00
Patrik Oldsberg 3a0d8edcb5 rename npm namespace from @spotify-backstage to @backstage 2020-03-25 19:12:11 +01:00
nikek 85f5ca9441 Structure documentation in /docs 2020-03-13 18:59:15 +01:00