Brian Fox
0b95bc1c6b
Align techdocs navigation with microsite
...
Signed-off-by: Brian Fox <brianhfox@gmail.com >
2021-04-23 09:58:30 +02:00
Patrik Oldsberg
67cc1f0416
Merge pull request #4421 from joaomilho/master
...
docs: Fix broken links in microsite
2021-02-26 17:35:43 +01:00
r.bideau
72722c1f6c
Add Google Analytics installation to sidebars and mkdocs
...
Signed-off-by: r.bideau <7304827+rbideau@users.noreply.github.com >
2021-02-22 10:31:59 +01:00
Juan Lulkin
69c64ac7f3
Merge remote-tracking branch 'upstream/master'
2021-02-21 00:03:29 +01:00
Patrik Oldsberg
021c70d673
Merge pull request #4564 from backstage/rugvip/docker-builds
...
docker: switch to backend:bundle + update docs with both host and multi-stage build
2021-02-18 11:01:47 +01:00
Fredrik Adelöw
6ebb0b19e9
Merge pull request #4561 from backstage/freben/integrations1
...
a small start to the integrations section of the config
2021-02-18 09:40:33 +01:00
Patrik Oldsberg
d13aea9cd2
docs: add full docker deployment docs
2021-02-17 20:44:10 +01:00
Fredrik Adelöw
83ff0988b1
a small start to the integrations section of the config
2021-02-17 13:50:08 +01:00
blam
d7abf2a2db
chore: fix some other wording
2021-02-16 15:19:31 +01:00
Juan Lulkin
31fc2168d8
Fix broken links in techdocs
2021-02-08 11:52:08 +01:00
Fredrik Adelöw
77fe4ef3cd
docs: add a miniature article about observability
2021-02-01 17:09:03 +01:00
Oliver Sand
fb118a6cf2
Add ADR for Plugin package Structure
2021-01-26 19:15:45 +01:00
Andrew Thauer
e58af307f0
docs: add use luxon date library adr
2021-01-19 10:08:17 -05:00
Emma Indal
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
Himanshu Mishra
e2030972fc
Merge pull request #4062 from backstage/orkohunter/use-urlreader-in-techdocs
2021-01-15 13:12:45 +01:00
Patrik Oldsberg
b6d6295f1d
Merge pull request #4072 from backstage/rugvip/docompost
...
docs: add documentation and migration instructions for new composability API
2021-01-15 13:02:06 +01:00
Emma Indal
057cb8e84f
Backstage Glossary Documentation ( #4073 )
...
* add Backstage Glossary documentation
* Update docs/glossary.md
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net >
* Update docs/glossary.md
Co-authored-by: Adam Harvey <adam.harvey@dxc.com >
* Update docs/glossary.md
Co-authored-by: Adam Harvey <adam.harvey@dxc.com >
* updates from feedback
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net >
Co-authored-by: Adam Harvey <adam.harvey@dxc.com >
2021-01-15 10:45:39 +01:00
Patrik Oldsberg
151e365040
docs/composability: ran prettier + added to mkdocs.yml
2021-01-14 12:53:25 +01:00
Himanshu Mishra
b2fc74ea16
docs: Write a HOW TO guide for using URL Reader
2021-01-14 12:22:45 +01:00
Himanshu Mishra
92e9fc9103
docs: move Kubernetes to core features ( #4038 )
2021-01-12 21:46:40 +00:00
Himanshu Mishra
ac88ca2038
Merge branch 'master' into orkohunter/techdocs-publish-to-cloud-storage
2020-12-09 20:17:06 +01:00
Frieder Bluemle
cbd3a44c09
Fix typos ( #3646 )
2020-12-09 07:50:41 +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
8fc3fc9629
TechDocs: Document basic and recommended architecture
2020-11-23 17:41:58 +01:00
Stefan Ålund
4df45e0083
(docs) Add Helm charts, cleanup ( #2944 )
...
* (docs) Add Helm charts, cleanup
* (docs) Add Helm charts, cleanup
2020-10-17 20:54:47 +02:00
Marcus Eide
c805350b72
Add documentation section about the project structure ( #2880 )
2020-10-14 09:50:41 +02:00
Fredrik Adelöw
277b1181ad
Merge pull request #2532 from spotify/freben/ref
...
feat(freben): add handling and docs for entity references
2020-09-25 08:41:29 +02:00
Himanshu Mishra
94aa8068af
TechDocs: Add troubleshooting docs
2020-09-24 16:20:16 +02:00
Stefan Ålund
06ae3734e7
[docs] Add links to CNCF information ( #2570 )
...
* [docs] restructure
* Add CNCF links
* Update background.md
* Update Footer.js
* Update README.md
2020-09-24 14:33:30 +02:00
Fredrik Adelöw
0222279021
feat(freben): add handling and docs for entity references
2020-09-22 15:27:13 +02:00
Fredrik Adelöw
94b8e88eba
fix(catalog-backend): address comments and add docs
2020-09-18 10:00:58 +02:00
Fredrik Adelöw
8989e83475
Merge pull request #2446 from spotify/freben-patch-2
...
Add reference to well known annotations
2020-09-14 09:29:04 +02:00
Fredrik Adelöw
8a0adf950a
Update mkdocs.yml etc
2020-09-14 09:07:22 +02:00
Himanshu Mishra
7bdcd2ee5b
Update mkdocks.yml for Techdocs rendering of the docs
2020-09-11 23:55:13 +02:00
Himanshu Mishra
84b72fbad1
Update mkdocks.yml for Techdocs rendering of the docs
2020-09-11 09:37:35 +02:00
Stefan Ålund
242bc8d111
Add Backstage logo assets ( #2395 )
...
* Add Backstage logo assets
* Update logos.md
* Update logos.md
* docs/verify-links: allow absolute URLs into microsite/static
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com >
2020-09-10 13:26:41 +02:00
Patrik Oldsberg
c792a2cfeb
mkdocs: add entry for scaffolder installation ( #2361 )
2020-09-09 13:17:10 +02:00
Patrik Oldsberg
f546bb3862
docs: added catalog configuration docs
2020-08-31 12:30:40 +02:00
Stefan Ålund
a8edb19f61
[Docs] Various fixes ( #2136 )
...
* [Docs] Various fixes
* More fixes
* Fix ADRs
* Typo
2020-08-27 13:27:22 +02:00
Emma Indal
40de8e03d4
TechDocs: update techdocs docs ( #2105 )
...
* docs(techdocs): update getting started docs
* docs(techdocs): update text and link to version
* fix docs link
* fix docs link
* Update docs/features/techdocs/getting-started.md
* update creating and publishing docs
2020-08-25 16:43:14 +02:00
Stefan Ålund
889e1fd4bb
Docs: strategies for adopting Backstage ( #2092 )
...
* Adopting guidelines
* More updates
* Tactics
* Add metrics
* Add MTTR
2020-08-24 16:37:51 +02:00
Stefan Ålund
3a6f4415eb
[Docs] Detailed roadmap and vision ( #1991 )
...
* [Docs] Update roadmap and vision
* Add shield to roadmap
* Update roadmap.md
* Link to .io in main README
* Fix verify links?
2020-08-18 10:52:56 +02:00
Govind
1aac6f1fb3
Add documentation explaining authentication in the backend ( #1963 )
...
* Add documentation explaining authentication in the backend
* Link newly added document to mkdocs and app documentation
Co-authored-by: Govindarajan Nagarajan <govindarajan.nagarajan@zalando.de >
2020-08-17 12:39:51 +02:00
Patrik Oldsberg
7c4307d1ee
docs: update storybook url
2020-08-14 09:20:09 +02:00
Stefan Ålund
ec13744b36
Document the service catalog ( #1922 )
2020-08-12 16:14:45 +02:00
Patrik Oldsberg
b25ffdc958
docs: added configuration docs ( #1863 )
...
* docs: added configuration docs
* docs: add all config pages to ToCs
2020-08-09 22:34:04 +02:00
David Tuite
7db913e36b
Add api-catalog.yaml file ( #1822 )
...
Also added ARD008 to explain the decision. This is linked from
`mkdocs.yaml` and `docs/README.md`.
Co-authored-by: David Tuite <dtuite@gmail.com >
2020-08-05 14:43:06 +02:00
Marcus Eide
abd953abbe
Merge pull request #1630 from spotify/blam/msw-adr
...
docs(adr): Created an ADR for MSW
2020-07-27 15:17:27 +02:00
David Tuite
ac5a6050aa
Write architecture overview ( #1685 )
...
This covers the frontend, backend, different plugin designs and
containerization.
Further work should cover authentication.
Co-authored-by: David Tuite <dtuite@gmail.com >
2020-07-22 00:23:46 +02:00
Stefan Ålund
ce30c43d24
[Docs] Fix relative paths to code ( #1662 )
...
* [Docs] Fix relative paths to code
* Update create-a-plugin.md
* Link to existing plugins
* Update README.md
* Update README.md
* Review edits
2020-07-16 09:17:43 +02:00