* Add TechdocsMetadata type in backend plugin endpoint
* Introduce TechDocsMetadata type in frontend
* Add changeset
* Remove old thennable metadata resp
* Address PR feedback
- Remove explicit type annotation on TechDocsMetadata
- Reintroduce res.send instead of throwing an error
- Change logger info to logger error
* Add TechDocsMetadata type in frontend plugin
* Commit yarn.lock
* Introduce JSON5 and remove parsing in local pub
Signed-off-by: Matei David <matei.david.35@gmail.com>
Spinners cause unnecessary UX distraction.
Case 1 (when docs are built and are to be served): Spinners appear for a split second before the name of site shows up. This unnecessarily distracts eyes because spinners increase the size of the Header. A dot (.) would do fine. Definitely more can be done.
Case 2 (when docs are being generated): There is already a linear progress bar (which is recommended in Storybook). Spinners are not good. 🤷
1. Don't use mkdocs in name of APIs or variables. It is an implementation detail and liable to change in future.
2. techDocsApi.getMetadata('mkdocs') and techDocsAPI.getMetadata('entity') should be two separate functions just because their responses differ in structure. They should also be type checked.
3. Use either 'techdocs' or 'TechDocs' consistently. 'techDocs' seems like an unnecessary third way to write TechDocs, which can be avoided.
4. Remove unused /plugins/techdocs-backend/src/service/metadata.ts file
* TechDocs: Logger already prints the name of plugin
* TechDocs: Display a custom error message if provided
* TechDocs: throw custom error message if index.md is not present
* Language improvements. Thanks @freben
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
* 'master' of github.com:spotify/backstage:
Read git auth token from backend config (#2992)
chore(catalog-model): add the petstore into the default entities
chore(deps-dev): bump @storybook/addon-actions from 6.0.21 to 6.0.26
chore(deps): bump eslint-config-prettier from 6.10.0 to 6.14.0
Add API docs link to About card
adds a sample organization set of users and groups (#2963)
Make sure hasCostsWithinTimeframe is a boolean
fix(catalog-backend): fix codeowners processor to handle users
feat(catalog): add simple client side paging
default to last 30 days
Removed default-branch library since it's no longer used (#3019)
useRealTimers in onCssReady test case
move type dependecy
remove unused import
changeset
simpler query params
* 'master' of github.com:spotify/backstage: (139 commits)
Cleanup
Update PinButton.test.tsx
feat: update github insights plugin version (#2973)
Ignore IntelliJ *.iml files (#2971)
chore(deps): bump rollup-plugin-dts from 1.4.11 to 1.4.13
fix the plugin card on plugins page
align 'Add to Marketplace' button on plugins page
fix the PluginGrid on mobiles sizes
use getBy query instead of queryBy when asserting for elements present in document (#2951)
Update PinButton.tsx
Add test case for Progress component (#2953)
fix the styling of footer copy on mobile
add changeset
handle the case where no entities are available to show
core-api: work around issue with ApiRef export const declarations
core-api: move utility api system implementation into apis/system
Update docs regarding npm config ignore-scripts flag
Another try
Fix Core Features configuration id (#2948)
Fix test?
...
* remove data-testid from div
* add test case for Progress component
* add changeset
* update the GraphiQLPage test cases to handle Progress timeout
* update the RadarComponent and RadarPage test case to handle Progress timeout
* update the TechDocsProgressBar test case to handle Progress timeout
* add changeset
* 'master' of github.com:spotify/backstage: (66 commits)
chore: fix lerna linting
v0.1.1-alpha.25
Add Code Insights plugin to sample app and marketplace (#2833)
Improve main CI build status badge in README (#2866)
Update roadmap: Design System 🚢 (#2858)
github/codecov: switch to informational mode
github/workflows: use the tip of master as the base for comparing PR code coverage
make saml provider path from globalConfig (#2855)
fix(catalog-backend): limit search value lengths
Update project Copyright (#2852)
fix(catalog-backend): actually use modified entity output (default namespace was broken)
remove unnecessary center keyword
Move card header bg to up contrast, fix#2558
Update name of env authentication env vars
Fix feedback from dtuite
Remove chart testing workflow for now
Only lint charts on Pull Requests
Move the k8s deployment docs to its own helm deployment page
Remove line in initdb script that creates backend db
Use app-config.development.yaml to provide configuration instead of local
...
* 'master' of github.com:spotify/backstage: (110 commits)
chore(catalog-backend): removing redudant classes and some functions
chore(deps-dev): bump @types/webpack from 4.41.21 to 4.41.22 (#2765)
move codecov.yml to .github
feat(catalog-backend): add batch concurrency
create-app: remove build step
cli: simplify jest transform ignore regex
feat(catalog-backend): introduce batching, speed up reading and writing of large datasets
Techdocs: add Azure DevOps prepare support (#2748)
feat(techdocs-header): Show breadcrumbs on docs page (#2786)
changesets: add entry for create-app template location fix
create-app: revert to github location type for example templates
fix: make catalog filter work again
Use new url scheme for techdocs
feat: remove LocationProcessor.processEntity
Add Dockerfile for helm chart
feat: use the new UrlReader in the CodeOwnersProcessor
feat: use new UrlReader in PlaceholderProcessor
feat: remove the backstage.io/definition-at-location annotation
Update loud-lamps-visit.md
feat(proxy-backend): limit the forwarded http headers to a safe set
...
* feat(techdocs): TechDocsPageWrapper to take in labels prop and use TechDocsHeader component
* feat(techdocs): new TechDocsHeader component as wrapper around Header from core
* feat(techdocs): TechDocsPage metadata
* feat(techdocs): TechDocsMetadata class responsible for reading metadata from generated techdocs metadata json file
* fix(techdocs): delete TechDocsPageWrapper component
* fix(app-config): delete /docs from request url
* feat(techdocs): TechDocsHeader with labels to browse metadata
* fix(techdocs): move metadata to backend plugin
* feat(techdocs-backend): introduce two new metadata routes
* feat(techdocs): new techdocs api to be responsible to request metadata from backend
* feat(techdocs): register new api for plugin
* fix(techdocs): reader to take in onReady prop
* fix(techdocs): TechDocsHome component to use its own header
* fix(techdocs): TechDocsPage responsible to get metadata and pass it down to the TechDocsHeader
* fix(techdocs): component tests for both TechDocsHeader and TechDocsPage
* fix(techdocs): adjust api to use /docs in url since it was taken away in requestURL
* fix(tests): move assertion into act
* fix(techdocs): rename TechDocsHeader to TechDocsPageHeader
* fix(techdocs): rename TechDocsHeader to TechDocsPageHeader
* fix(techdocs-backend): add some logs
* Update plugins/techdocs/src/reader/components/TechDocsPage.test.tsx
* delete unused import
* Inject CSS transformer and initial backstage style integration for reader
* Update plugins/techdocs/src/reader/transformers/injectCss.test.ts
Co-authored-by: Emma Indal <emmai@spotify.com>
* Fix test name and run injectCss in preTransformer
* Fix for invisible links in reader
* Added missing semi-colon
* Better styling on codeblocks
Co-authored-by: Emma Indal <emmai@spotify.com>
* enable allowVulnerableTags in sanitize-html
* Fixed lint issue
* Removed style tag from allowed list. Seems to work fine.
* Added tests to make sure we keep link tags and remove style tags
* Added age check for documentation in github to make sure it's up to date
* Updated failing tests
* Updated docs to explain requestUrl and storageUrl
* Updated failing tests
* Update packages/create-app/templates/default-app/app-config.yaml.hbs
* Update docs/features/techdocs/getting-started.md
Co-authored-by: Emma Indal <emmai@spotify.com>
* migrate techdocs to use new routing
* use new techdocs routing in default app
* new EntityPageDocs and Router components
* remove unused code
* remove unused import
* Updated docs for techdocs plugin
* Error in example comment
* Update plugins/techdocs/README.md
Co-authored-by: Emma Indal <emmai@spotify.com>
* Update plugins/techdocs/src/reader/README.md
Co-authored-by: Emma Indal <emmai@spotify.com>
* Update plugins/techdocs/src/reader/README.md
Co-authored-by: Emma Indal <emmai@spotify.com>
* Update plugins/techdocs/src/reader/README.md
Co-authored-by: Emma Indal <emmai@spotify.com>
* Update link to transformers doc to point to reader doc for now
Co-authored-by: Emma Indal <emmai@spotify.com>
Matei David