f680c6cd21
TechDocs: Update docs to use URL Reader over dir preparer
2021-01-28 15:12:41 +01:00
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
cb99b8fc1d
chore: prettier makes pretty
2021-01-26 17:07:27 +01:00
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
2f547a668f
chore: fix spelling mistake
2021-01-26 16:03:26 +01:00
46533ed01b
chore: fix the config key for scaffolderr
2021-01-26 15:53:32 +01:00
00448abb03
chore: updating docs reference to integrations condfig
2021-01-26 15:52:30 +01:00
682b2c6a10
Fix typo
2021-01-25 14:51:32 -05:00
e6904cb3d6
Tweak wording
2021-01-25 14:49:55 -05:00
45621d88ea
Update descriptions
2021-01-25 14:46:48 -05:00
8abed46a1f
Reorg Kubernetes section
2021-01-25 14:42:10 -05:00
5e6ed92cb9
fix: use the right link to the class CatalogProcessor on GitHub ( #4238 )
2021-01-25 11:06:47 +01:00
979bcccf23
chore: fixing last of the typescripts
2021-01-21 20:06:49 +01:00
5ebe5dc83e
Merge pull request #4185 from backstage/Fox32-patch-1
...
Small fix in descriptor format
2021-01-21 13:25:54 +01:00
3c9439bfde
Small fix in descriptor format
...
We decided not to include providesApi/consumesApis in the system entity for now
2021-01-21 12:55:30 +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
d72fb2dd5d
docs: Fix url links in well known annotations
...
URL Reader's readTree does not support default branch yet, so it has to be specified. The PR https://github.com/backstage/backstage/pull/4120 adds support for the default branch. So, this change can be reverted once the support is released.
Created after https://github.com/backstage/backstage/pull/4147
2021-01-20 14:18:45 +01:00
1d4ce77fc8
Merge pull request #4147 from SDA-SE/feat/origin-location
...
Block the deletion of entities from the bootstrap location in the unregister dialog and list the correct delete preview
2021-01-20 10:50:35 +01:00
b0d50574d3
More review comments
2021-01-20 10:14:56 +01:00
d6cecee891
Merge pull request #4113 from n2ygk/patch-1
...
document using locally-installed cookiecutter
2021-01-19 17:45:30 +01:00
4b5c4cc5ce
Update with review comments
2021-01-19 16:44:00 +01:00
f47b54614d
docs: Run prettier on techdocs ci/cd tutorial
2021-01-19 16:09:43 +01:00
def2307f33
Add a managed-by-origin-location annotation
2021-01-19 15:54:16 +01:00
82ca95e375
minor editorial suggestions from @freben and @adamdmharvey
2021-01-19 09:50:10 -05: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
e019935409
prettier
2021-01-18 14:24:56 -05:00
4211198c30
Merge pull request #4128 from backstage/rugvip/fetch
...
backend-common: lock down UrlReader to only read from allowed URLs
2021-01-18 18:53:19 +01:00
5345a1f983
backend-common: lock down UrlReader to only read from allowed URLs
2021-01-18 14:17:04 +01:00
85d864c19f
Search Roadmap and Architecture ( #4030 )
...
* search documentation and roadmap
* fixup
* add link to architecture issue
* formatting
* add nav to mkdocs yaml and microsite sidebar
* use backstage search instead of backstage global search
* add file extension to app_config
* Update docs/features/search/README.md
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net >
* replace Big Picture with Architecture
* search architecture wip
* changes to architecture and documentation to it
* update used user profiles according to the glossary
* prettier ignore description
* clarify architecture bullet points with examples
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net >
2021-01-18 12:01:54 +01:00
bba8b99255
document using locally-installed cookiecutter
...
This avoids running Docker in Docker.
See https://github.com/backstage/backstage/blob/57460cda021bddaf04e7c3351c3881a3f24859b0/plugins/scaffolder-backend/src/scaffolder/stages/templater/cookiecutter.ts#L56-L79
See also https://backstage.io/docs/features/techdocs/getting-started#disabling-docker-in-docker-situation-optional where it is configurable.
2021-01-15 16:25:06 -05: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
92e9fc9103
docs: move Kubernetes to core features ( #4038 )
2021-01-12 21:46:40 +00: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
9b9a561298
Document subcomponentOf field
2021-01-12 16:00:00 +00:00
c3d90881ce
Merge pull request #4026 from backstage/orkohunter/improve-aws-credentials-handling
2021-01-12 15:33:25 +01:00
63b92ca5f0
Merge pull request #3957 from SDA-SE/feat/system-domains
...
Introduce structure for domains, systems and resources
2021-01-12 15:29:21 +01:00
619ef5978c
Merge pull request #4020 from adamdmharvey/k8s-doco
...
docs: Update Kubernetes microsite documentation
2021-01-12 15:14:16 +01:00
0728c5ad7d
Fix typo
2021-01-12 09:07:52 -05:00
c773e00d54
Remove providesApis and consumesApis from systems
...
We can later add them again.
2021-01-12 15:05:47 +01:00
192b0b70a8
Update vale vocabulary to unify company and product names
2021-01-12 13:52:58 +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
7105a33b91
Update K8S doco
2021-01-11 20:56:45 -05:00
Himanshu Mishra