Commit Graph

268 Commits

Author SHA1 Message Date
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
Himanshu Mishra 0513536be8 docs(TechDocs): Update publisher milestones about AWS and Azure storage 2021-01-06 15:25:22 +01:00
Adam Harvey ea071d5f6c Proper case vendor name 2021-01-05 13:42:50 -05:00
Adam Harvey 14466940f7 Single line metadata and prettier ignore 2021-01-05 13:42:31 -05:00
Himanshu Mishra 0b9646ed6a Merge pull request #3794 from ayshiff/feature/techdocs-aws-s3 2021-01-05 17:48:57 +01:00
Remi 3169c9bad1 feat(techdocs): update aws-S3 diagram 2020-12-30 10:25:58 +01:00
Remi 4c327b2345 fix(techdocs): remove aws credentials file 2020-12-30 10:25:57 +01:00
Remi 80b60862af feat(techdocs): updates aws variables access 2020-12-30 10:25:57 +01:00
Remi b9e6d305e2 fix(techdocs): typos + add tests + requested changes 2020-12-30 10:25:57 +01:00
Remi 134888fb21 fix(techdocs): format + doc quality check 2020-12-30 10:25:57 +01:00
Remi 77102b420a feat(techdocs): update docs 2020-12-30 10:25:57 +01:00
Adam Harvey 11e34f12cb Remove completed TODO 2020-12-30 00:01:58 -05:00
Adam Harvey 457fb1df87 Fix ref to exempli gratia 2020-12-30 00:00:32 -05:00
Adam Harvey 64b8d49fcd Fix typo 2020-12-29 23:59:41 -05:00
Himanshu Mishra 82f241f90c Merge pull request #3764 from backstage/orkohunter/techdocs-backend-refactor-factory-methods 2020-12-21 19:10:38 +01:00
Himanshu Mishra 9af7248c45 docs: Update techdocs architecture features status 2020-12-19 11:21:03 +01:00
Himanshu Mishra 305693a59a docs: Update techdocs backend instructions to use latest factory methods
Smaller than before <3
2020-12-17 11:42:08 +01:00
Himanshu Mishra d96f61bd70 Merge pull request #3718 from backstage/orkohunter/update-techdocs-project-status-docs 2020-12-16 16:25:13 +01:00
Himanshu Mishra eb39a633e8 docs: Improvements suggested by Anders 2020-12-16 15:42:26 +01:00
Fredrik Adelöw a71599b163 Merge pull request #3465 from SDA-SE/feat/remote-implements-apis
Remove implementsApis
2020-12-16 10:17:44 +01:00
Himanshu Mishra 2e9734a3c1 docs: Level up header types in techdocs concepts page 2020-12-15 19:55:18 +01:00
Himanshu Mishra ef63d159df docs: 1. Techdocs Backend everywhere
2. TechDocs Backend instead Backstage
3. Link to scaffolder
2020-12-15 11:27:38 +01:00
Oliver Sand c911061b75 Add profile section to group entity 2020-12-15 10:19:44 +01:00
Himanshu Mishra 6baef24bcf Update TechDocs documentation, overview, gettings started, support status, concepts, etc.
1. Add a table of all the platforms that are supported and that are in pipeline. Add issue to trac
k their progress.
2. Update concepts about publisher, and add preparer and generator
3. Getting started is now complete, describes both backend and frontend, and has better setting the configuration section.
4. Some typos and code comments
2020-12-15 09:08:40 +01:00
Himanshu Mishra 92ecddbe24 techdocs-common: Unify response type of Local and googleGcs publisher 2020-12-09 20:32:41 +01:00
Himanshu Mishra ac88ca2038 Merge branch 'master' into orkohunter/techdocs-publish-to-cloud-storage 2020-12-09 20:17:06 +01:00
Himanshu Mishra 511f59f021 1. Use $file for googleGcs.credentials
2. Clarify that techdocs-common is only used in backend plugin since it is compiled to commonJS
2020-12-09 20:11:33 +01:00