e7686833fd
docs: fix typos in the documentation ( #2633 )
2020-09-28 13:18:40 +02:00
94aa8068af
TechDocs: Add troubleshooting docs
2020-09-24 16:20:16 +02:00
521728348d
backend: change the default backend plugin mount point to /api
2020-09-23 09:39:47 +02:00
f097c32b59
TechDocs: Use a flag to determine if we should use a local mkdocs or techdocs-container ( #2503 )
...
* Use a flag to determine wether to use techdocs-container or local install of mkdocs
* Updated techdocs generator to look at app-config string instead of argument to decide how to run the generator
* Removed console log...
* Reverted scaffolder file that was accidentally committed.
* Fixed lint issues
* Added config to create-app template
2020-09-18 14:02:35 +02:00
485fa981d2
prettified md
2020-09-17 01:38:58 +05:30
3347cf1668
grammar correction
2020-09-17 00:14:06 +05:30
ff65589796
added description header field
2020-09-16 23:06:14 +05:30
d833cd9fe8
added description header field
2020-09-16 22:14:28 +05:30
812da7539f
added description header field
2020-09-16 21:56:32 +05:30
def4032351
added description header field
2020-09-16 21:47:19 +05:30
0597211af1
Merge pull request #2433 from timja/support-user-or-org
...
scaffolder: Allow user or org, remove hard coded isOrg
2020-09-15 09:17:25 +02:00
b1051d50e8
Add FAQ about file formats
2020-09-12 00:09:07 +02:00
e87263e839
Some minor improvements to docs
2020-09-12 00:01:11 +02:00
7b1b539e8c
Remove the manual edit instructions
...
There is an edit button on the website
2020-09-12 00:00:40 +02:00
506d130854
Some minor improvements to docs
2020-09-11 23:55:01 +02:00
08856c7da9
Add TechDocs architecture page
2020-09-11 23:54:28 +02:00
a5e6e17fd3
Avoid duplication, redirect to Backstage getting started
2020-09-11 23:38:34 +02:00
64d2edc097
Updates to the TechDocs overview page
...
- Add a one line context to what docs-like-code means
- Add link to announcement blog post which is very in-depth about TechDocs
- Milestone update and typo
2020-09-11 23:35:32 +02:00
c95fd141ae
Remove hardcoded isOrg
2020-09-11 22:17:58 +01:00
0b95f633d9
Update v1 milestone in project roadmap
2020-09-11 08:07:34 +02:00
902781c36f
docs: fix broken fragment links
2020-09-10 17:50:36 +02:00
72c097f57f
Use correct npm package for serving
2020-09-10 09:08:23 +01:00
d865f88344
[TechDocs] Rebuild docs if the github source is newer than last docs build ( #2353 )
...
* Added age check for documentation in github to make sure it's up to date
* Updated failing tests
* Updated docs to explain requestUrl and storageUrl
* Updated failing tests
* Update packages/create-app/templates/default-app/app-config.yaml.hbs
* Update docs/features/techdocs/getting-started.md
Co-authored-by: Emma Indal <emmai@spotify.com >
2020-09-09 16:05:28 +02:00
0fa4c72a92
revert yarn.lock
...
upgrade Storybook to version 6
update storybook renderer layout
docs: update create app command and link
revert yarn.lock changes
revert yarn.lock
revert yarn
2020-09-09 00:37:06 +12:00
b045b166b6
run prettier
2020-09-05 16:37:30 +02:00
cd3dde5af6
add techdocs big picture to docs ( #2153 )
2020-08-28 11:56:22 +02:00
2bb585f4fe
TechDocs: add note to docs about limitations to the scaffolder ( #2134 )
...
* add warning to docs about limitations to the scaffolder
* Update docs/features/techdocs/creating-and-publishing.md
2020-08-27 13:15:09 +02:00
0b2f787699
Updated docs for techdocs plugin ( #2127 )
...
* Updated docs for techdocs plugin
* Error in example comment
* Update plugins/techdocs/README.md
Co-authored-by: Emma Indal <emmai@spotify.com >
* Update plugins/techdocs/src/reader/README.md
Co-authored-by: Emma Indal <emmai@spotify.com >
* Update plugins/techdocs/src/reader/README.md
Co-authored-by: Emma Indal <emmai@spotify.com >
* Update plugins/techdocs/src/reader/README.md
Co-authored-by: Emma Indal <emmai@spotify.com >
* Update link to transformers doc to point to reader doc for now
Co-authored-by: Emma Indal <emmai@spotify.com >
2020-08-27 09:52:49 +02:00
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
8d4e14e1c5
Update versions in upcoming features
2020-08-14 15:07:03 +02:00
882728ae1d
feat: the whole docs structure
...
Co-authored-by: Raghunandan Balachandran <meetraghu28@gmail.com >
Co-authored-by: Ben Lambert <ben@blam.sh >
2020-08-12 15:20:20 +02:00
0867d3dc30
feat: more docs to backstage.io
2020-08-12 12:06:14 +02:00
7529211cc0
fix(roadmap): switch links to milestones for v2 and v3
2020-08-11 20:07:17 +02:00
38737c9e73
fix(roadmap): adjust project roadmap and link to use cases for v2
2020-08-11 20:04:09 +02:00
b0032f9739
Added v2 to techdocs readme
2020-08-11 18:47:34 +02:00
7462a1d5a1
fixup
2020-08-10 14:29:59 +02:00
96bc61aeb2
Add use cases connected to TechDocs versions in project roadmap
2020-08-10 14:25:26 +02:00
0fe2ddf70f
Tweaks to techdocs docs
...
Text editing
2020-07-30 17:04:03 +02:00
fb3284a35b
fix(techdocs): clean up unused links
2020-07-22 11:55:16 +02:00
12f4979cdf
fix(techdocs): updated link in techdocs README.md to point to new file
2020-07-22 11:53:06 +02:00
ebdfadc3f9
fix(techdocs): remove unused doc files and merge some docs into one file
2020-07-22 11:51:42 +02:00
5c61ec0ed5
Merge pull request #1703 from spotify/emmai/techdocs-docs-concepts
...
Techdocs: concept documentation
2020-07-21 17:05:03 +02:00
6404144d13
fix(techdocs): updated concepts documentation.
2020-07-21 17:02:22 +02:00
4f5ed073f3
fix(techdocs-docs-concepts): TechDocs concept documentation
2020-07-21 15:02:36 +02:00
a6b33a0faf
wip
2020-07-21 11:00:35 +02:00
6406d8f863
fix(techdocs-faq-docs): Add section to FAQ
2020-07-21 08:34:06 +02:00
8a949c3f3d
Merge pull request #1650 from spotify/mob/techdocs-publishing-documentation
...
TechDocs: Updated documentation on publishing-documentation.md
2020-07-15 16:42:23 +02:00
38e9eb419a
docs(techdocs): Updated documentation on how to publish documentation in TechDocs.
2020-07-15 16:36:05 +02:00
0349b22948
docs(techdocs): pratial documentation on how to publish documentation in techdocs
2020-07-14 17:24:29 +02:00
04ad54cba2
docs(techdocs): added content to getting started with techdocs as a plugin to Backstage.
2020-07-14 15:00:18 +02:00
Navaneeth Suresh