paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
9,221 Commits 1 Branch 0 Tags
c3ea694e8400a35e2dfe4cf577c0fa66c66a8570
Commit Graph

123 Commits

Author SHA1 Message Date
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
Himanshu Mishra 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
Himanshu Mishra 97716f2b04 Apply suggestions from code review 
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
 2021-01-11 20:50:20 +01:00
Himanshu Mishra bcc27a495d TechDocs: doc improvements 
Co-authored-by: Emma Indal <emmai@spotify.com>
 2021-01-11 14:04:17 +01:00
Himanshu Mishra ba86ff2d8c TechDocs/GCS: Update docs regarding credentials and removed projectId key 2021-01-09 16:42:21 +01:00
Himanshu Mishra 0513536be8 docs(TechDocs): Update publisher milestones about AWS and Azure storage 2021-01-06 15:25:22 +01:00
Adam Harvey 14466940f7 Single line metadata and prettier ignore 2021-01-05 13:42:31 -05:00
Himanshu Mishra 0b9646ed6a Merge pull request #3794 from ayshiff/feature/techdocs-aws-s3 2021-01-05 17:48:57 +01:00
Remi 3169c9bad1 feat(techdocs): update aws-S3 diagram 2020-12-30 10:25:58 +01:00
Remi 4c327b2345 fix(techdocs): remove aws credentials file 2020-12-30 10:25:57 +01:00
Remi 80b60862af feat(techdocs): updates aws variables access 2020-12-30 10:25:57 +01:00
Remi b9e6d305e2 fix(techdocs): typos + add tests + requested changes 2020-12-30 10:25:57 +01:00
Remi 134888fb21 fix(techdocs): format + doc quality check 2020-12-30 10:25:57 +01:00
Remi 77102b420a feat(techdocs): update docs 2020-12-30 10:25:57 +01:00
Adam Harvey 11e34f12cb Remove completed TODO 2020-12-30 00:01:58 -05:00
Adam Harvey 64b8d49fcd Fix typo 2020-12-29 23:59:41 -05:00
Himanshu Mishra 82f241f90c Merge pull request #3764 from backstage/orkohunter/techdocs-backend-refactor-factory-methods 2020-12-21 19:10:38 +01:00
Himanshu Mishra 9af7248c45 docs: Update techdocs architecture features status 2020-12-19 11:21:03 +01:00
Himanshu Mishra 305693a59a docs: Update techdocs backend instructions to use latest factory methods 
Smaller than before <3
 2020-12-17 11:42:08 +01:00
Himanshu Mishra eb39a633e8 docs: Improvements suggested by Anders 2020-12-16 15:42:26 +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
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 1051e5f342 Rebuild yarn.lock after new release 2020-12-03 23:00:49 +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
Himanshu Mishra 4122b3031f feat(backstage.io): Allow to zoom images like Medium 2020-11-29 14:02:08 +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
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