Commit Graph

770 Commits

Author SHA1 Message Date
Eric Peterson 4abe217004 Link from overall roadmap to search feedback issue. 2021-01-22 11:07:37 +01:00
blam 979bcccf23 chore: fixing last of the typescripts 2021-01-21 20:06:49 +01:00
Oliver Sand 5ebe5dc83e Merge pull request #4185 from backstage/Fox32-patch-1
Small fix in descriptor format
2021-01-21 13:25:54 +01:00
Oliver Sand 3c9439bfde Small fix in descriptor format
We decided not to include providesApi/consumesApis in the system entity for now
2021-01-21 12:55:30 +01:00
Himanshu Mishra 53203c083f Update docs/features/techdocs/architecture.md
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-01-20 21:53:44 +01:00
Himanshu Mishra ce9b017341 docs: TechDocs FAQ about using it without techdocs-backend 2021-01-20 21:26:38 +01:00
Patrik Oldsberg 45b857a060 Merge pull request #4142 from SDA-SE/feat/update-adr006
Update adr006 on using PropsWithChildren
2021-01-20 19:36:11 +01:00
Himanshu Mishra d72fb2dd5d docs: Fix url links in well known annotations
URL Reader's readTree does not support default branch yet, so it has to be specified. The PR https://github.com/backstage/backstage/pull/4120 adds support for the default branch. So, this change can be reverted once the support is released.

Created after https://github.com/backstage/backstage/pull/4147
2021-01-20 14:18:45 +01:00
Patrik Oldsberg 0833137c40 Merge pull request #4155 from backstage/rugvip/noreg
core-api: remove deprecated registerRoute and deprecate addRoute
2021-01-20 12:02:34 +01:00
Dominik Henneke 1d4ce77fc8 Merge pull request #4147 from SDA-SE/feat/origin-location
Block the deletion of entities from the bootstrap location in the unregister dialog and list the correct delete preview
2021-01-20 10:50:35 +01:00
Dominik Henneke b0d50574d3 More review comments 2021-01-20 10:14:56 +01:00
Patrik Oldsberg a187b8ad0a core-api: remove deprecated registerRoute and deprecate addRoute 2021-01-19 23:50:38 +01:00
Andrew Thauer 54dd7b3003 Merge pull request #3980 from andrewthauer/date-lib-adr
docs: add use luxon date library adr
2021-01-19 12:42:53 -05:00
Patrik Oldsberg d6cecee891 Merge pull request #4113 from n2ygk/patch-1
document using locally-installed cookiecutter
2021-01-19 17:45:30 +01:00
Dominik Henneke 4b5c4cc5ce Update with review comments 2021-01-19 16:44:00 +01:00
Fredrik Adelöw e50718a9c8 Merge pull request #4146 from backstage/orkohunter/catalogue-to-catalog
docs: Search arch diagram catalogue -> catalog
2021-01-19 16:31:33 +01:00
Himanshu Mishra f47b54614d docs: Run prettier on techdocs ci/cd tutorial 2021-01-19 16:09:43 +01:00
Andrew Thauer 6878af026e remove adr status header 2021-01-19 10:09:02 -05:00
Andrew Thauer 3ac428e26a Update docs/architecture-decisions/adr010-luxon-date-library.md
Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
2021-01-19 10:08:18 -05:00
Andrew Thauer 8bf638945d change date lib adr status to accepted 2021-01-19 10:08:18 -05:00
Andrew Thauer 068b1bbe22 Update docs/architecture-decisions/adr010-luxon-date-library.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-01-19 10:08:17 -05:00
Andrew Thauer 7e15bcb32c Update docs/architecture-decisions/adr010-luxon-date-library.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-01-19 10:08:17 -05:00
Andrew Thauer e58af307f0 docs: add use luxon date library adr 2021-01-19 10:08:17 -05:00
Dominik Henneke def2307f33 Add a managed-by-origin-location annotation 2021-01-19 15:54:16 +01:00
Alan Crosswell 82ca95e375 minor editorial suggestions from @freben and @adamdmharvey 2021-01-19 09:50:10 -05:00
Himanshu Mishra cfc0b73951 Update docs/features/techdocs/configuring-ci-cd.md
Co-authored-by: bodilb <66826349+bodilb@users.noreply.github.com>
2021-01-19 15:05:52 +01:00
Himanshu Mishra 3e24d89290 1. Use --storage-name instead of bucket name
2. Prettier ignore description
3. Refer to CLI readme
2021-01-19 14:00:57 +01:00
Himanshu Mishra 6c64b4b8b9 docs: Search arch diagram catalogue -> catalog 2021-01-19 13:56:18 +01:00
Himanshu Mishra 6b6bcb549a Apply suggestions from code review
Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
2021-01-19 13:18:37 +01:00
Himanshu Mishra 0dc2e8a97e docs: fix npx command for techdocs-cli 2021-01-19 13:18:37 +01:00
Himanshu Mishra d9de82ee6c docs: How to build TechDocs sites on CI/CD workflows 2021-01-19 13:18:35 +01:00
Oliver Sand 61abb1a500 Update adr006 on using PropsWithChildren 2021-01-19 10:36:27 +01:00
Patrik Oldsberg b9b4caa493 Merge pull request #4140 from backstage/rugvip/noadr
docs/adrs: remove status
2021-01-19 10:06:55 +01:00
Patrik Oldsberg b473cf08b5 docs/adrs: remove status 2021-01-19 09:55:11 +01:00
Alan Crosswell e019935409 prettier 2021-01-18 14:24:56 -05:00
Patrik Oldsberg 4211198c30 Merge pull request #4128 from backstage/rugvip/fetch
backend-common: lock down UrlReader to only read from allowed URLs
2021-01-18 18:53:19 +01:00
Himanshu Mishra 0799cb87de Merge pull request #4057 from backstage/orkohunter/remove-unused-dockerfile 2021-01-18 16:36:14 +01:00
Patrik Oldsberg 5345a1f983 backend-common: lock down UrlReader to only read from allowed URLs 2021-01-18 14:17:04 +01:00
Emma Indal 85d864c19f Search Roadmap and Architecture (#4030)
* search documentation and roadmap

* fixup

* add link to architecture issue

* formatting

* add nav to mkdocs yaml and microsite sidebar

* use backstage search instead of backstage global search

* add file extension to app_config

* Update docs/features/search/README.md

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

* replace Big Picture with Architecture

* search architecture wip

* changes to architecture and documentation to it

* update used user profiles according to the glossary

* prettier ignore description

* clarify architecture bullet points with examples

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-01-18 12:01:54 +01:00
Fredrik Adelöw a6f8333fce Merge pull request #4093 from backstage/emmaindal/microsite-sidebar-glossary
[Microsite] Glossary to show up in sidebar on microsite
2021-01-18 10:31:17 +01:00
Patrik Oldsberg 0e457a840c Merge pull request #4116 from backstage/rugvip/typiskt
docs: add docs for how to handle type checking issues with linked in packages
2021-01-18 10:04:54 +01:00
Johan Haals 5618ffa733 Merge pull request #4058 from backstage/mob/github-app-manager
Add GithubCredentialsProvider for start of GitHub Apps support
2021-01-18 08:10:26 +01:00
Himanshu Mishra cca03162bc chore: Remove yarn docker-build:app command and related docs 2021-01-17 21:53:37 +01:00
Patrik Oldsberg f5cc804ca3 docs: add docs for how to handle type checking issues with linked in packages 2021-01-16 15:44:40 +01:00
Alan Crosswell bba8b99255 document using locally-installed cookiecutter
This avoids running Docker in Docker.

See https://github.com/backstage/backstage/blob/57460cda021bddaf04e7c3351c3881a3f24859b0/plugins/scaffolder-backend/src/scaffolder/stages/templater/cookiecutter.ts#L56-L79

See also https://backstage.io/docs/features/techdocs/getting-started#disabling-docker-in-docker-situation-optional where it is configurable.
2021-01-15 16:25:06 -05:00
Adam Harvey 33f7fbc5b2 Fix wrapping 2021-01-15 14:12:23 -05:00
Adam Harvey 177f7984d8 Add TechDocs CLI for mkdocs build errors 2021-01-15 14:10:09 -05:00
Johan Haals 48f3a5dcae Update docs 2021-01-15 16:13:19 +01:00
Johan Haals 50b933d9ac Update docs/plugins/github-apps.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-01-15 15:42:39 +01:00
Johan Haals b5ed171a1a Update docs/plugins/github-apps.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-01-15 15:42:25 +01:00