ae508116d9
docs: TechDocs revamp techdocs architecture page
...
Remove/Update features which have been implemented.
2021-02-01 12:02:44 +01:00
f27b40e6af
docs: TechDocs HOW TO migrate from basic to recommended approach
2021-02-01 11:42:23 +01:00
8eb862c58e
Merge pull request #4017 from viavarejo/feature/techdocs-azure-storage
2021-01-31 16:03:24 +01:00
baf5615b51
Clarifications
2021-01-29 14:17:26 -05:00
4f32647f00
TechDocs: docs - Add reference link to techdocs-ref annotation
2021-01-28 20:20:19 +01:00
ee271bf86e
feat(docs): update Azure Blob Storage
2021-01-28 16:17:30 -03:00
0024d6d8c0
feat(techdocs-common): update Azure Blob Storage
2021-01-28 16:17:28 -03:00
0be9694aa6
feat(techdocs-common): update Azure Blob Storage
2021-01-28 16:17:27 -03:00
74d34c8ff9
feat(docs): update Azure Blob Storage
2021-01-28 16:16:22 -03:00
42494c7e91
feat(docs): add Azure Blob Storage
2021-01-28 16:16:22 -03:00
c777df180a
feat(techdocs-common): add Azure Storage
2021-01-28 16:16:21 -03:00
f680c6cd21
TechDocs: Update docs to use URL Reader over dir preparer
2021-01-28 15:12:41 +01:00
53203c083f
Update docs/features/techdocs/architecture.md
...
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com >
2021-01-20 21:53:44 +01:00
ce9b017341
docs: TechDocs FAQ about using it without techdocs-backend
2021-01-20 21:26:38 +01:00
f47b54614d
docs: Run prettier on techdocs ci/cd tutorial
2021-01-19 16:09:43 +01:00
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
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
6b6bcb549a
Apply suggestions from code review
...
Co-authored-by: Adam Harvey <adam.harvey@dxc.com >
2021-01-19 13:18:37 +01:00
0dc2e8a97e
docs: fix npx command for techdocs-cli
2021-01-19 13:18:37 +01:00
d9de82ee6c
docs: How to build TechDocs sites on CI/CD workflows
2021-01-19 13:18:35 +01:00
33f7fbc5b2
Fix wrapping
2021-01-15 14:12:23 -05:00
177f7984d8
Add TechDocs CLI for mkdocs build errors
2021-01-15 14:10:09 -05:00
b2fc74ea16
docs: Write a HOW TO guide for using URL Reader
2021-01-14 12:22:45 +01:00
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
f454b9f865
TechDocs/AWS: Update tutorial with auth best practices
2021-01-12 12:35:13 +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
7ed4807748
1. docs: Rephrase setting the config
...
2. Update changeset with info about removing projectId from googleGcs config
2021-01-11 21:05:23 +01:00
97716f2b04
Apply suggestions from code review
...
Co-authored-by: Fredrik Adelöw <freben@gmail.com >
2021-01-11 20:50:20 +01:00
bcc27a495d
TechDocs: doc improvements
...
Co-authored-by: Emma Indal <emmai@spotify.com >
2021-01-11 14:04:17 +01:00
ba86ff2d8c
TechDocs/GCS: Update docs regarding credentials and removed projectId key
2021-01-09 16:42:21 +01:00
0513536be8
docs(TechDocs): Update publisher milestones about AWS and Azure storage
2021-01-06 15:25:22 +01:00
14466940f7
Single line metadata and prettier ignore
2021-01-05 13:42:31 -05:00
0b9646ed6a
Merge pull request #3794 from ayshiff/feature/techdocs-aws-s3
2021-01-05 17:48:57 +01:00
3169c9bad1
feat(techdocs): update aws-S3 diagram
2020-12-30 10:25:58 +01:00
4c327b2345
fix(techdocs): remove aws credentials file
2020-12-30 10:25:57 +01:00
80b60862af
feat(techdocs): updates aws variables access
2020-12-30 10:25:57 +01:00
b9e6d305e2
fix(techdocs): typos + add tests + requested changes
2020-12-30 10:25:57 +01:00
134888fb21
fix(techdocs): format + doc quality check
2020-12-30 10:25:57 +01:00
77102b420a
feat(techdocs): update docs
2020-12-30 10:25:57 +01:00
11e34f12cb
Remove completed TODO
2020-12-30 00:01:58 -05:00
64b8d49fcd
Fix typo
2020-12-29 23:59:41 -05:00
82f241f90c
Merge pull request #3764 from backstage/orkohunter/techdocs-backend-refactor-factory-methods
2020-12-21 19:10:38 +01:00
9af7248c45
docs: Update techdocs architecture features status
2020-12-19 11:21:03 +01:00
305693a59a
docs: Update techdocs backend instructions to use latest factory methods
...
Smaller than before <3
2020-12-17 11:42:08 +01:00
eb39a633e8
docs: Improvements suggested by Anders
2020-12-16 15:42:26 +01:00
2e9734a3c1
docs: Level up header types in techdocs concepts page
2020-12-15 19:55:18 +01:00
ef63d159df
docs: 1. Techdocs Backend everywhere
...
2. TechDocs Backend instead Backstage
3. Link to scaffolder
2020-12-15 11:27:38 +01:00
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
92ecddbe24
techdocs-common: Unify response type of Local and googleGcs publisher
2020-12-09 20:32:41 +01:00
ac88ca2038
Merge branch 'master' into orkohunter/techdocs-publish-to-cloud-storage
2020-12-09 20:17:06 +01:00
Himanshu Mishra