Commit Graph

294 Commits

Author SHA1 Message Date
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
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
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 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
Himanshu Mishra f47b54614d docs: Run prettier on techdocs ci/cd tutorial 2021-01-19 16:09:43 +01: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 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
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
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
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
Himanshu Mishra b2fc74ea16 docs: Write a HOW TO guide for using URL Reader 2021-01-14 12:22:45 +01:00
Himanshu Mishra 92e9fc9103 docs: move Kubernetes to core features (#4038) 2021-01-12 21:46:40 +00:00
Fredrik Adelöw ffa36ff101 Merge pull request #3927 from adamdmharvey/doco-prettier-seo
docs: Align Docusaurus for fixed SEO output and "prettier" happiness
2021-01-12 21:42:53 +01:00
James Turley 9b9a561298 Document subcomponentOf field 2021-01-12 16:00:00 +00:00
Himanshu Mishra c3d90881ce Merge pull request #4026 from backstage/orkohunter/improve-aws-credentials-handling 2021-01-12 15:33:25 +01:00
Oliver Sand 63b92ca5f0 Merge pull request #3957 from SDA-SE/feat/system-domains
Introduce structure for domains, systems and resources
2021-01-12 15:29:21 +01:00
Fredrik Adelöw 619ef5978c Merge pull request #4020 from adamdmharvey/k8s-doco
docs: Update Kubernetes microsite documentation
2021-01-12 15:14:16 +01:00
Adam Harvey 0728c5ad7d Fix typo 2021-01-12 09:07:52 -05:00
Oliver Sand c773e00d54 Remove providesApis and consumesApis from systems
We can later add them again.
2021-01-12 15:05:47 +01:00
Dominik Henneke 192b0b70a8 Update vale vocabulary to unify company and product names 2021-01-12 13:52:58 +01:00
Himanshu Mishra f454b9f865 TechDocs/AWS: Update tutorial with auth best practices 2021-01-12 12:35:13 +01:00
Himanshu Mishra 16b73697a3 TechDocs/AWS: Enable authentication using env variables and ~/.aws/config shared file
If authentication secrets are provided in app-config.yaml, it will be used. If not, environment variables AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_REGION will be used. If not present, ~/.aws/config will be used to read the configs.

https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-environment.html
https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html
https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-region.html
2021-01-12 11:41:00 +01:00
Adam Harvey 7105a33b91 Update K8S doco 2021-01-11 20:56:45 -05:00
Himanshu Mishra 15cc6ff12c Merge pull request #3981 from backstage/orkohunter/improve-gcs-credentials-handling 2021-01-11 21:12:55 +01:00
Himanshu Mishra 7ed4807748 1. docs: Rephrase setting the config
2. Update changeset with info about removing projectId from googleGcs config
2021-01-11 21:05:23 +01:00
Oliver Sand 15432e61f1 Rework system model diagrams as drawio files 2021-01-11 20:56:55 +01:00
Himanshu Mishra 97716f2b04 Apply suggestions from code review
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-01-11 20:50:20 +01:00
Oliver Sand feded2d252 Include review comments 2021-01-11 20:23:52 +01:00
Matthew Clarke 5a9a7e7c26 Kubernetes plugin: UI revamp (#3918)
* initial revamp, no error reporting

* initial error detection

* more error detection

* add microsite page

* minor fixes

* add HPA error detection

* refactor error reporting; add tests

* fix import

* add changeseet

* empty error state

* prettier yaml file

* Update plugins/kubernetes/src/components/KubernetesDrawer/KubernetesDrawer.tsx

Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>

* Update plugins/kubernetes/src/components/KubernetesDrawer/KubernetesDrawer.tsx

Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>

* PR feedback

* revert odd change

* make patch change

* fix test

* Apply suggestions from code review

Co-authored-by: Fredrik Adelöw <freben@gmail.com>

* prettier

* pr feedback

Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-01-11 16:50:30 +00:00
Himanshu Mishra bcc27a495d TechDocs: doc improvements
Co-authored-by: Emma Indal <emmai@spotify.com>
2021-01-11 14:04:17 +01:00
Himanshu Mishra ba86ff2d8c TechDocs/GCS: Update docs regarding credentials and removed projectId key 2021-01-09 16:42:21 +01:00
Oliver Sand 4254f760f5 Use the table for all entity references 2021-01-08 17:30:08 +01:00
Oliver Sand 541cff1a2f Introduce a general way to mark entity references 2021-01-08 09:41:16 +01:00
Oliver Sand 9795d529d3 Make domain only a reference of a system 2021-01-08 09:21:39 +01:00
Oliver Sand 657f7fff6d Introduce structure for domains, systems and resources 2021-01-07 14:48:07 +01:00