Commit Graph

228 Commits

Author SHA1 Message Date
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
Himanshu Mishra 24bcdd0829 techdocs: Use googleGcs for publisher type instead of google_gcs 2020-12-09 18:58:12 +01:00
Himanshu Mishra 9d08ef8f46 techdocs: replace 'build' with 'generate' in most places 2020-12-09 16:01:29 +01:00
Himanshu Mishra 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
Frieder Bluemle cbd3a44c09 Fix typos (#3646) 2020-12-09 07:50:41 +01:00
Himanshu Mishra 8736de114a Merge remote-tracking branch 'origin/master' into orkohunter/techdocs-publish-to-cloud-storage 2020-12-08 08:12:38 +01:00
Fredrik Adelöw d2f81dd290 Merge pull request #3373 from backstage/freben/remove-ancestors-descendants
catalog: remove group ancestors and descendants
2020-12-07 09:40:38 +01:00
Oliver Sand ac3560b42d Remove implementsApis
This was deprecated in #3449. This should not be merged sooner then Dec 14th, 2020!
2020-12-07 09:21:53 +01:00
Himanshu Mishra 1051e5f342 Rebuild yarn.lock after new release 2020-12-03 23:00:49 +01:00
Himanshu Mishra f0bfd369b3 Merge remote-tracking branch 'origin/master' into orkohunter/techdocs-publish-to-cloud-storage 2020-12-03 22:53:45 +01:00
Himanshu Mishra 084670b37a Google Cloud Storage working with TechDocs (publish and fetch)
Plus
1. Introduce ncessary configs to connect with storage
2. Introduce config to prefer CI build of docs, or techdocs-backend to build and publish them.
3. Write guide how to use Google Cloud Storage with TechDocs
4. Add a TechDocs Configuration reference page in docucmentation
2020-12-03 22:40:15 +01:00
Fredrik Adelöw 08835a61d9 catalog: add support for relative targets and implicit types in Location entities 2020-12-02 07:30:58 +01:00
Himanshu Mishra 4122b3031f feat(backstage.io): Allow to zoom images like Medium 2020-11-29 14:02:08 +01:00
Fredrik Adelöw 83b6e0c1fc catalog: remove group ancestors and descendants 2020-11-26 19:06:50 +01:00
Oliver Sand 68650afeb2 Clarify that consumesApi and providesApi are two different relationships
This follows the implementation in  #3408
2020-11-26 17:57:51 +01:00
Oliver Sand 069cda35f4 Deprecate implementsApis 2020-11-25 16:21:08 +01:00
Oliver Sand fb19e0241d Add providesApis and consumesApis to component spec 2020-11-25 16:01:34 +01:00
Oliver Sand 11e4a9cbe8 Integrate review comments 2020-11-24 16:23:41 +01:00
Oliver Sand 6579b08725 Link to substitutions instead of duplicating the content 2020-11-24 16:10:59 +01:00
Oliver Sand b0f286b83c Document Substitutions In The Descriptor Format 2020-11-24 16:02:44 +01:00
Himanshu Mishra 1d55b1e976 Merge pull request #3336 from backstage/mob/techdocs-storage-solutions-spec 2020-11-24 14:30:42 +01:00
Himanshu Mishra 8fc3fc9629 TechDocs: Document basic and recommended architecture 2020-11-23 17:41:58 +01:00
Oliver Sand da2f4cd41a Add graphql API type to descriptor format (#3395) 2020-11-23 12:08:46 +01:00
Fredrik Adelöw 1185919f39 catalog: mark ancestors and descendants for deprecation (#3392) 2020-11-23 11:29:37 +01:00
Ben Lambert 09fde576c1 Merge pull request #3393 from adamdmharvey/doco-updates
Fixes when referring to entity YAML filename to use new standard catalog-info.yaml
2020-11-23 10:10:20 +01:00
Adam Harvey 5c8e99ce19 Fix entity YAML name 2020-11-22 20:38:57 -05:00
blam 9075c4816b docs: added a note about templates should have catalog-info 2020-11-22 02:51:10 +01:00
Oliver Sand 0c21212400 Add support for reading groups and users from the Microsoft Graph API. (#3293)
* Add support for reading groups and users from the Microsoft Graph API.

* Limit amount of parallel requests

* Add helper for paging in odata collections

* Add tests for the microsoft graph reader

* Output the correct relations between groups and users
2020-11-20 12:53:12 +01:00
Fredrik Adelöw ecf1e06cda docs: flesh out the catalog Extending the model section (#3352) 2020-11-20 12:10:40 +01:00
Himanshu Mishra 1b3e2db75f TechDocs: Add basic and production deployment architecture diagrams 2020-11-19 21:18:37 +01:00
Himanshu Mishra 00b60af58a docs: Correct URL of techdocs-container 2020-11-19 09:26:31 +01:00
Himanshu Mishra a2b83df986 Merge pull request #3316 from backstage/orkohunter/add-techdocs-survey
TechDocs Survey: Add link to form on docs site
2020-11-17 13:46:54 +01:00
Fredrik Adelöw 22f7755d29 docs: skip prettier for long metadata lines (#3311) 2020-11-17 13:26:24 +01:00
Himanshu Mishra d1bfe7b71f Docs: Add TechDocs survey on docs site 2020-11-17 13:19:28 +01:00
Fredrik Adelöw 3ad6320029 docs: catalog - extending the model, and relations (#3291)
* docs: catalog - extending the model, and relations

* Address comments
2020-11-16 16:45:46 +01:00
Andrés Torres 39eef81349 fix: link to examples in Catalog docs (#3271)
Fix reference to artist-lookup-component.yaml path in Catalog docs, the new folder structure is missing
2020-11-10 12:12:17 +01:00
David Tuite 3b02444c12 Fix reference to Catalog path in overview docs (#3255)
While you do end up on the catalog if you visit `/`, the browser URL is actually `/catalog`.
2020-11-05 23:10:45 +01:00
David Tuite 85379551e0 Add CircleCI to the Well Known Annotations (#3082) 2020-11-05 22:48:28 +01:00
Himanshu Mishra 5dd4a338db Docs update of techdocs-cli URL 2020-11-05 15:29:27 +01:00
Himanshu Mishra 47a611f115 TechDocs: Remove techdocs-container package from mono-repo (#3230)
* Move techdocs-container package to backstage/techdocs-container

* Clean up codeowners

* Remove unnecessary GitHub CI workflow

* Modify path in docs for techdocs-container

* Fix techdocs-cli URL

* Remove techdocs packages from docs/support/packages
2020-11-05 14:58:48 +01:00
Fredrik Adelöw 596a3b8d14 docs: features/software-catalog/external-integrations (#3231) 2020-11-04 20:01:03 +01:00