Commit Graph

205 Commits

Author SHA1 Message Date
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
Himanshu Mishra bd0ae748c0 Merge pull request #3172 from backstage/orkohunter/update-techdocs-contrib-docs 2020-11-04 11:29:13 +01:00
Himanshu Mishra d5c74f0415 Merge pull request #3216 from backstage/orkohunter/remove-techdocs-core-from-mono-repo 2020-11-03 15:51:22 +01:00
Himanshu Mishra 878eb60958 TechDocs: Update repo URL in documentation: 2020-11-03 11:49:01 +01:00
Himanshu Mishra b8e67816c9 Remove mkdocs-techdocs-core from backstage mono-repo
New home: https://github.com/backstage/mkdocs-techdocs-core
2020-11-03 11:45:43 +01:00
Patrik Oldsberg 474bb5b57f rewrite other references to spotify/backstage and sorrounding things 2020-11-03 11:39:27 +01:00
Patrik Oldsberg af141c0766 rewrite repo location urls 2020-11-03 11:03:49 +01:00
Oliver Sand 678f0309dd Merge pull request #3013 from SDA-SE/dry-run-experiment
Allow to dry run the register component operation
2020-10-30 16:50:08 +01:00
Himanshu Mishra 6018855f34 TechDocs: Add caveat around Markdown version 2020-10-30 10:28:31 +01:00
Dominik Henneke da0a79c3b8 feat: add sonarqube plugin (#3160) 2020-10-30 09:52:39 +01:00
Himanshu Mishra efff67c205 TechDocs: Update docs around docker-in-docker installation
Fix python package name to mkdocs-techdocs-core
Refer to the original Dockerfile where users can seek inspiration from
2020-10-30 09:49:53 +01:00
Oliver Sand 948052cbb4 feat: add ability to dry run adding a new location
The location is now added in a transaction and afterwards rolled back. This allows users to dry run this operation to see if there entity has issues. This is probably done my automated tools.
2020-10-29 20:11:38 +01:00
Vividh Chandna fa56f46158 fix: Update tags validation message & documentation (#3145)
* Update dns label validation message to match regex pattern

* Update documentation for tags validation & examples

* Add changeset
2020-10-29 16:58:18 +01:00
Patrik Oldsberg 7c28026ae0 docs: update scaffolder-backend installation docs 2020-10-26 23:34:25 +01:00
Ben Lambert b173dacb46 Merge pull request #3087 from adamdmharvey/doc-clarifications
Clarifications in documentation
2020-10-26 14:56:08 +01:00
Adrian Ke Chongyang 31ba976ea8 edit techdocs documentation (#3058)
* edit techdocs documentation

* Update docs/features/techdocs/creating-and-publishing.md

Co-authored-by: Emma Indal <emma.indahl@gmail.com>

Co-authored-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
Co-authored-by: Emma Indal <emma.indahl@gmail.com>
2020-10-26 08:56:55 +01:00
Harvey 15ca9fe630 Clarify plural and product capitalization 2020-10-25 23:22:38 -04:00
Adam Harvey c6c54b1b3a Clarifications to software template documentation (#3070)
* Clarify scaffolders

* Tweak preparer

* Template clarifications

* Minor wording for clarity

* Change wording
2020-10-23 23:20:30 +02:00
Emma Indal 06df0eba4c Update V.2 in TechDocs Roadmap (#3021)
* Update V.2 in TechDocs Roadmap

* prettier
2020-10-22 16:10:37 +02:00
Eduardo Apolinario c3113d1d39 Fix Core Features configuration id (#2948)
The current configuration id is pointing to an inexistent place. This PR fixes the name of the configuration node in sidebars.json.
2020-10-18 08:13:06 +02:00
Althaf Hameez d4f221bee2 Update techdocs url to the new default 2020-10-14 19:26:58 +08:00
Eric Peterson 3727322ecd Clarify catalog info YAML, TechDocs (#2882)
* Add note about catalog-info.yaml convention to format docs.

* Improve TechDocs Create & Publish Docs:
- Clarify the two paths to getting started
- Clarify `catalog-info.yaml` / component registration
- Minor grammar cleanup

* Correct link to software catalog overview
2020-10-14 09:58:21 +02:00
Oliver Sand c6d1f4846f Merge pull request #2803 from SDA-SE/feat/remove-api-annotation
feat: remove the backstage.io/definition-at-location annotation
2020-10-08 16:25:31 +02:00
Oliver Sand e6b00e3af9 feat: remove the backstage.io/definition-at-location annotation
The annotation was superseded by the placeholder processor.
2020-10-08 15:50:16 +02:00