a6f9dca0dc
plugins should not depend on core-api
2021-01-14 08:54:54 +01:00
99a778ac9f
Use history.pushState for hash link navigation in techdocs
2021-01-13 23:21:34 +01:00
fda570687e
Update plugins/techdocs/config.d.ts
...
Co-authored-by: Emma Indal <emmai@spotify.com >
2021-01-12 14:43:52 +01:00
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
bcc27a495d
TechDocs: doc improvements
...
Co-authored-by: Emma Indal <emmai@spotify.com >
2021-01-11 14:04:17 +01:00
e7954559ab
TechDocs/GCS: Remove projectId since it is not needed
...
I initially thought the GCS Nodejs client would make use of it, since it asked for it in the contructor. However, we may not need them at all. Buckets are gloablly unique anyway.
2021-01-09 16:29:42 +01:00
1ef5d0f13c
TechDocs/GCS: Enable authentication using environemnt variables
...
GOOGLE_APPLICATION_CREDENTIALS is the environment variable used by the client. Compute Engine, Google Kubernetes Engine, App Engine, Cloud Run, and Cloud Functions automatically provide a default service account and set this env variable.
https://cloud.google.com/docs/authentication/production
2021-01-09 16:07:39 +01:00
28d7f319f4
Version Packages
2021-01-07 10:31:20 +00:00
3418938a64
feat(techdocs): update config schema
2020-12-30 10:25:58 +01:00
a1ebbdeee0
Version Packages
2020-12-29 10:59:38 +00:00
bd3bc94ff8
Merge pull request #3799 from keshann93/plugins/techdocs
2020-12-28 20:52:53 +01:00
c3c04658f2
Version Packages
2020-12-22 12:14:20 +00:00
851dde45f7
updated the missed attr change
2020-12-21 16:31:01 +05:30
e53d4a2ca8
updated based on the feedbacks provided
2020-12-21 16:26:58 +05:30
359f9d2d8c
Introduced config schema for techdocs plugins
2020-12-21 16:26:57 +05:30
6e9f4d4a15
Version Packages
2020-12-17 10:16:33 +00:00
15d23c004e
Merge remote-tracking branch 'origin/master' into orkohunter/techdocs-publish-to-cloud-storage
2020-12-10 21:12:31 +01:00
cf187484bf
Version Packages
2020-12-10 11:25:39 +00:00
ac88ca2038
Merge branch 'master' into orkohunter/techdocs-publish-to-cloud-storage
2020-12-09 20:17:06 +01:00
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
24bcdd0829
techdocs: Use googleGcs for publisher type instead of google_gcs
2020-12-09 18:58:12 +01:00
9d08ef8f46
techdocs: replace 'build' with 'generate' in most places
2020-12-09 16:01:29 +01:00
9bd130a73a
techdocs: Use 'local' and 'external' for alternatives for techdocs.builder config
...
Co-authored-by: freben <freben@gmail.com >
2020-12-09 12:31:40 +01:00
8b395bee26
Add standard NPM metadata
2020-12-08 13:42:23 -05:00
8736de114a
Merge remote-tracking branch 'origin/master' into orkohunter/techdocs-publish-to-cloud-storage
2020-12-08 08:12:38 +01:00
87a33d2fe8
[TechDocs] Bug fixes and cleanups ( #3599 )
...
* Fixed issue with some internal doc links reloading the page and removed modifyCss transformer
* Create silly-kiwis-rest.md
* Formatting in changeset
2020-12-07 16:49:24 +01:00
372160ede5
Update README of all three techdocs packages/plugins
2020-12-05 18:07:50 +01:00
a212e43142
techdocs: Add JSON Schema config
...
Show better error if techdocs.builder is set to 'ci' and if no docs are found.
Return 404 from googleStorage client when a file is not found.
2020-12-05 10:48:54 +01:00
11340fb2f6
techdocs: Remove spinners
...
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. 🤷
2020-12-04 22:09:38 +01:00
f0bfd369b3
Merge remote-tracking branch 'origin/master' into orkohunter/techdocs-publish-to-cloud-storage
2020-12-03 22:53:45 +01:00
01aa774d9a
Version Packages
2020-12-03 15:28:22 +00:00
ff348df9fe
techdocs-common: Initialize package and move common code from techdocs-backend
2020-12-01 20:48:58 +01:00
85af34ffd5
techdocs: Use EntityName from catalog-model as Entity type
2020-11-28 20:02:40 +01:00
892645b815
Version Packages
2020-11-27 12:51:09 +00:00
dbca620ff9
Use fs-extra and async file read method
2020-11-26 20:41:40 +01:00
266e93b478
TechDocs: Refactor metadata retrieval
...
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
2020-11-25 19:39:48 +01:00
8fd5e64351
TechDocs: Tell users when index.md is missing (better error message) ( #3429 )
...
* 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 >
2020-11-25 09:52:19 +01:00
7d564164fd
Version Packages
2020-11-24 13:34:37 +00:00
1d55b1e976
Merge pull request #3336 from backstage/mob/techdocs-storage-solutions-spec
2020-11-24 14:30:42 +01:00
8fc3fc9629
TechDocs: Document basic and recommended architecture
2020-11-23 17:41:58 +01:00
bc0f47b7b7
Version Packages
2020-11-19 15:13:57 +00:00
717e43de14
catalog-client: change entities interface, add fields support ( #3296 )
2020-11-18 19:58:36 +01:00
9621ef3a96
techdocs: add storageUrl to config schema
...
Co-authored-by: Sebastian Qvarfordt <s.qvarfordt@gmail.com >
2020-11-18 11:31:18 +01:00
feb9905a37
plugins: add config schema needed by frontend plugins
2020-11-18 11:31:15 +01:00
05ae2a4e52
cli: remove plugin:export
2020-11-16 13:17:35 +01:00
76a8099029
Version Packages
2020-11-12 10:52:23 +00:00
42b0dbddcb
feat(catalog-client): create a basic catalog client ( #3166 )
2020-11-04 13:18:03 +01:00
715bb76fb5
Version Packages
2020-11-03 20:50:42 +00:00
8360d9f7e2
Merge pull request #3140 from backstage/rugvip/release
...
Release v0.1.1
2020-11-03 13:28:03 +01:00
5e8a88bc9a
Merge pull request #3126 from vividh/fix/techdocs-page-title
2020-10-28 15:03:37 +01:00
Fredrik Adelöw