Commit Graph

347 Commits

Author SHA1 Message Date
Himanshu Mishra b0501f8348 docs(TechDocs): Add more context with AWS docs hyperlinks 2021-02-17 11:09:49 +01:00
Himanshu Mishra a2518e3dbe docs(TechDocs): Update docs around AWS SDK downgrade to v2 2021-02-16 19:03:07 +01:00
Fredrik Adelöw 68aba8682b fix a few little things in the entity docs 2021-02-15 10:21:17 +01:00
Eric Peterson 174a63c466 Merge pull request #4472 from backstage/iameap/clarify-search-architecture
[Search] Clarify search architecture
2021-02-11 10:13:42 +01:00
Himanshu Mishra 14f04073ef Merge pull request #4475 from backstage/orkohunter/docs-techdocs-github-actions-ci-example 2021-02-11 09:54:34 +01:00
Himanshu Mishra 7dc1e43c55 docs(TechDocs): Improvements to the CI example
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-02-11 09:28:08 +01:00
Himanshu Mishra 0869aa161a docs(TechDocs): Add GitHub Actions CI example with AWS S3 2021-02-10 19:31:00 +01:00
Emma Indal 9c42fdf4ba [Search] documentation update (#4459)
* delete link to issue as it is closed

* replace usage of easy as its very subjective

* Update docs/features/search/architecture.md

Co-authored-by: Adam Harvey <adam.harvey@dxc.com>

* prettier....:

Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
2021-02-10 16:12:35 +01:00
Eric Peterson 0c56a7f74f Clarify intentions around bulk vs. incremental index management. 2021-02-10 14:00:27 +01:00
Eric Peterson eef4423e7b Define relationship to software catalog and loose coupling by convention. 2021-02-10 13:58:49 +01:00
Himanshu Mishra 66944ec7bf TechDocs: Preparers will take and return an etag for cache invalidation 2021-02-10 11:01:18 +01:00
Emma Indal 98cdb20f01 update roadmap with milestones links (#4453) 2021-02-09 11:03:54 +01:00
Himanshu Mishra 43397061fd docs(TechDocs): docs/ is configurable by mkdocs.yml 2021-02-06 17:26:44 +01:00
Himanshu Mishra 29e269d920 TechDocs: Remove traces of requestUrl/storageUrl from docs 2021-02-02 13:52:45 +01:00
Parth Shandilya e44925723e TechDocs: Make requestUrl and storageUrl optional configs by using discovery APIs
closes #3715

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-02-02 13:51:04 +01:00
Himanshu Mishra 79fd002145 Merge pull request #4335 from backstage/orkohunter/docs-techdocs-migrate-basic-to-recommended 2021-02-01 15:16:16 +01:00
Ben Lambert c0a5e2710a Update docs/features/software-templates/index.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-02-01 13:41:20 +01:00
Ben Lambert 5d42c04218 Update docs/features/software-templates/index.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-02-01 13:41:14 +01:00
Himanshu Mishra ae508116d9 docs: TechDocs revamp techdocs architecture page
Remove/Update features which have been implemented.
2021-02-01 12:02:44 +01:00
Himanshu Mishra f27b40e6af docs: TechDocs HOW TO migrate from basic to recommended approach 2021-02-01 11:42:23 +01:00
blam 978d4ab5a2 docs(software-templates): updating docs for storePath 2021-02-01 10:54:53 +01:00
Himanshu Mishra 8eb862c58e Merge pull request #4017 from viavarejo/feature/techdocs-azure-storage 2021-01-31 16:03:24 +01:00
Adam Harvey baf5615b51 Clarifications 2021-01-29 14:17:26 -05:00
Adam Harvey e763dcf8c4 Fix Backstage case 2021-01-29 14:17:09 -05:00
Adam Harvey 357c1f1e5f Clarify link and Backstage case 2021-01-29 14:16:26 -05:00
Himanshu Mishra 26bb405108 Merge pull request #4287 from backstage/orkohunter/dir-preparer-uses-url-reader 2021-01-29 09:56:55 +01:00
Himanshu Mishra 4f32647f00 TechDocs: docs - Add reference link to techdocs-ref annotation 2021-01-28 20:20:19 +01:00
vitorgrenzel ee271bf86e feat(docs): update Azure Blob Storage 2021-01-28 16:17:30 -03:00
vitorgrenzel 0024d6d8c0 feat(techdocs-common): update Azure Blob Storage 2021-01-28 16:17:28 -03:00
vitorgrenzel 0be9694aa6 feat(techdocs-common): update Azure Blob Storage 2021-01-28 16:17:27 -03:00
vitorgrenzel 74d34c8ff9 feat(docs): update Azure Blob Storage 2021-01-28 16:16:22 -03:00
vitorgrenzel 42494c7e91 feat(docs): add Azure Blob Storage 2021-01-28 16:16:22 -03:00
vitorgrenzel c777df180a feat(techdocs-common): add Azure Storage 2021-01-28 16:16:21 -03:00
Andrew Thauer 1362709953 fix entity link examples 2021-01-28 12:24:34 -05:00
Andrew Thauer 97e8e69368 Update docs/features/software-catalog/descriptor-format.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-01-28 12:24:33 -05:00
Andrew Thauer 34f76899bd Update docs/features/software-catalog/descriptor-format.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-01-28 12:24:32 -05:00
Andrew Thauer 18c6261dde Update docs/features/software-catalog/descriptor-format.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-01-28 12:24:32 -05:00
Andrew Thauer 87411c4036 Update docs/features/software-catalog/descriptor-format.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-01-28 12:24:32 -05:00
Andrew Thauer 232f8a58ea add entity links example yaml 2021-01-28 12:24:30 -05:00
Andrew Thauer b47136bd34 add entity links example json 2021-01-28 12:24:28 -05:00
Andrew Thauer 6e612ce252 feat: add entity metadata links 2021-01-28 12:24:28 -05:00
Himanshu Mishra f680c6cd21 TechDocs: Update docs to use URL Reader over dir preparer 2021-01-28 15:12:41 +01:00
Ben Lambert 67d8da9fd1 Merge pull request #4261 from backstage/blam/docs-change
docs: Update scaffolder docs for integrations config
2021-01-26 17:30:09 +01:00
blam cb99b8fc1d chore: prettier makes pretty 2021-01-26 17:07:27 +01:00
Ben Lambert e77a8dc14e Update docs/features/software-templates/installation.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-01-26 17:02:03 +01:00
blam 2f547a668f chore: fix spelling mistake 2021-01-26 16:03:26 +01:00
blam 46533ed01b chore: fix the config key for scaffolderr 2021-01-26 15:53:32 +01:00
blam 00448abb03 chore: updating docs reference to integrations condfig 2021-01-26 15:52:30 +01:00
Adam Harvey 682b2c6a10 Fix typo 2021-01-25 14:51:32 -05:00
Adam Harvey e6904cb3d6 Tweak wording 2021-01-25 14:49:55 -05:00