Commit Graph

159 Commits

Author SHA1 Message Date
Himanshu Mishra c1de2a809a docs: Add TechDocs FAQ about annotation value when using external build and storage
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-03-11 23:28:13 +01:00
r.bideau ca4a904f6b Add techdocs.publisher.awsS3.endpoint config option
Signed-off-by: r.bideau <7304827+rbideau@users.noreply.github.com>
2021-03-08 13:56:32 +01:00
erdoganoksuz 7bf88b4f31 error name and documentation consistency.
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 12:17:06 +03:00
erdoganoksuz aa095e469f pull request feedbacks fix.
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 12:16:21 +03:00
Mert Can Bilgiç 37586e0fc9 runned prettier
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 12:16:21 +03:00
gmzsenturk a10174b56d Documentations edited
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 11:47:01 +03:00
gmzsenturk 2ebfe29d8a Cloud storage documentation edited
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 11:46:34 +03:00
gmzsenturk fc470a310e Updated cloud storage documentation for open stack
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 11:46:25 +03:00
erdoganoksuz cebda81000 documentation added
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 11:46:23 +03:00
Himanshu Mishra b90c83e329 TechDocs: Update features based on Gary's feedback 2021-03-01 10:12:26 +01:00
Himanshu Mishra 8fbd591fd4 TechDocs: Update roadmap with milestones 2021-03-01 10:12:26 +01:00
Jonah Back f41ac17b29 Merge branch 'master' into feature/aws-assume-role 2021-02-17 12:39:25 -08:00
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
Jonah Back 05e169464c run prettier fix 2021-02-11 15:32:52 -08:00
Jonah Back 9c80eca8d5 Update docs/features/techdocs/using-cloud-storage.md
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-02-11 14:24:49 -08:00
Jonah Back 0d8b3253a4 Update docs/features/techdocs/using-cloud-storage.md
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-02-11 14:23:37 -08:00
Jonah Back 58fdcb6a30 add docs around assuming role for techdocs storage 2021-02-11 12:49:03 -08: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
Himanshu Mishra 66944ec7bf TechDocs: Preparers will take and return an etag for cache invalidation 2021-02-10 11:01:18 +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 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
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
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
Himanshu Mishra f680c6cd21 TechDocs: Update docs to use URL Reader over dir preparer 2021-01-28 15:12:41 +01:00
Himanshu Mishra 53203c083f Update docs/features/techdocs/architecture.md
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-01-20 21:53:44 +01:00
Himanshu Mishra ce9b017341 docs: TechDocs FAQ about using it without techdocs-backend 2021-01-20 21:26:38 +01:00
Himanshu Mishra f47b54614d docs: Run prettier on techdocs ci/cd tutorial 2021-01-19 16:09:43 +01:00
Himanshu Mishra cfc0b73951 Update docs/features/techdocs/configuring-ci-cd.md
Co-authored-by: bodilb <66826349+bodilb@users.noreply.github.com>
2021-01-19 15:05:52 +01:00
Himanshu Mishra 3e24d89290 1. Use --storage-name instead of bucket name
2. Prettier ignore description
3. Refer to CLI readme
2021-01-19 14:00:57 +01:00
Himanshu Mishra 6b6bcb549a Apply suggestions from code review
Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
2021-01-19 13:18:37 +01:00
Himanshu Mishra 0dc2e8a97e docs: fix npx command for techdocs-cli 2021-01-19 13:18:37 +01:00
Himanshu Mishra d9de82ee6c docs: How to build TechDocs sites on CI/CD workflows 2021-01-19 13:18:35 +01:00
Adam Harvey 33f7fbc5b2 Fix wrapping 2021-01-15 14:12:23 -05:00
Adam Harvey 177f7984d8 Add TechDocs CLI for mkdocs build errors 2021-01-15 14:10:09 -05:00
Himanshu Mishra b2fc74ea16 docs: Write a HOW TO guide for using URL Reader 2021-01-14 12:22:45 +01: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
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