Commit Graph

25 Commits

Author SHA1 Message Date
Emma Indal ff5da01280 TechDocs: techdocs backend tests (#2196)
* add tests for generators class

* add tests for helpers

* renaming

* fixup
2020-09-01 09:54:05 +02:00
Rod Machen 57c3e2ad5b update software template docs 2020-08-28 14:07:25 -05:00
Sebastian Qvarfordt f6698e2e0c Added some more docs for techdocs-backend (#2124)
* Added some more docs for techdocs-backend

* Update plugins/techdocs-backend/README.md

Co-authored-by: Emma Indal <emmai@spotify.com>

* Update plugins/techdocs-backend/README.md

Co-authored-by: Emma Indal <emmai@spotify.com>

* Added example of techdocs storageUrl config

Co-authored-by: Emma Indal <emmai@spotify.com>
2020-08-26 15:42:02 +02:00
Raghunandan 734dcca107 Release v0.1.1-alpha.20 2020-08-26 11:33:14 +02:00
Sebastian Qvarfordt a027e632a0 Merge latest changes from origin before rebuilding docs (#2117)
* Added missing tests and make sure we merge latest changes before building docs from a repo

* Removed flaky test
2020-08-25 17:03:10 +02:00
Sebastian Qvarfordt f6826d9107 Moved git clone to a helper functions and added tests for preparers (#2112) 2020-08-25 16:21:53 +02:00
Sebastian Qvarfordt 2e50876160 Throw error when failing to generate docs to prevent request loop (#2073) 2020-08-21 15:30:50 +02:00
Emma Indal f6f56aa748 TechDocs: documentation template (#1954)
* feat(docs-template): Add docs template to create a standalone docs project

* fix(docs-template): add docs template to mock data

* fix(docs-template): owner of template

* add techdocs-ref to cookiecutter docs project

* delete unused cookiecutter json file

* update docs in default index.md file

* rename from .yaml to .yml to be consistent to docs

* update techdocs-ref to use github protocol
2020-08-21 14:56:46 +02:00
Raghunandan Balachandran 9b8024352a Merge pull request #2046 from spotify/new-release-20-aug-20
Release v0.1.1-alpha.19
2020-08-21 14:13:56 +02:00
Sebastian Qvarfordt 613c06bdd6 Techdocs: Updates preparers to make it work in actual usecases (#1957)
* feature(techdocs): JIT generation of techdocs

* Fix linting issues

* Add Techdocs tab to entity page

* Added missing dep

* Added missing dep

* Removed duplicate dep

* Better tab navigation

* Update label on entity page to say docs

* Fix lint issue

* Move building of docs from entity to a function

* feature(techdocs): JIT generation of techdocs

* Fix linting issues

* Add Techdocs tab to entity page

* Added missing dep

* Added missing dep

* Removed duplicate dep

* Better tab navigation

* Update label on entity page to say docs

* Fix lint issue

* Move building of docs from entity to a function

* attempt to add back react as a dep

* Fixed failing test

* fix(techdocs): Hopefully fixed tests

* Fixed another failing test

* Initial apiRef for techdocs storage

* Cleaned up some code in reader

* test(headertabs): add tests to HeaderTabs component

* fix(headertabs): change tab mock id

* fix(techdocs-generator): fix problem with macOS symlink to tmp folder

* fix(lint): remove unused configApiRef

* wip

* Ongoing cleanups

* Cleanups and fix tests

* Initial github preparer. Doesn't work properly yet

* Updated dir preparer to handle github managed-by-location and added github preparer

* Removed old file

* Fixed feedback and added better logging to techdocs build process

* Updated create-app template

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Co-authored-by: Emma Indal <emmai@spotify.com>
2020-08-21 12:11:03 +02:00
Raghunandan 15e334a584 Release v0.1.1-alpha.19 2020-08-21 11:40:04 +02:00
Sebastian Qvarfordt 13908d69c2 TechDocs: Access entity techdocs from service catalog (#1835)
* feature(techdocs): JIT generation of techdocs

* Fix linting issues

* Add Techdocs tab to entity page

* Added missing dep

* Added missing dep

* Removed duplicate dep

* Better tab navigation

* Update label on entity page to say docs

* Fix lint issue

* Move building of docs from entity to a function

* feature(techdocs): JIT generation of techdocs

* Fix linting issues

* Add Techdocs tab to entity page

* Added missing dep

* Added missing dep

* Removed duplicate dep

* Better tab navigation

* Update label on entity page to say docs

* Fix lint issue

* Move building of docs from entity to a function

* attempt to add back react as a dep

* Fixed failing test

* fix(techdocs): Hopefully fixed tests

* Fixed another failing test

* Initial apiRef for techdocs storage

* Cleaned up some code in reader

* test(headertabs): add tests to HeaderTabs component

* fix(headertabs): change tab mock id

* fix(techdocs-generator): fix problem with macOS symlink to tmp folder

* fix(lint): remove unused configApiRef

* wip

* Ongoing cleanups

* Cleanups and fix tests

* WIP cleanups

* Clean up some things

* Clean up some things

* Added missing notice header

* ts issue fixed

* Add show contition to api tab

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Co-authored-by: Emma Indal <emmai@spotify.com>
2020-08-20 14:06:09 +02:00
Oliver Sand 774a000729 Readme for api-docs Plugin (#2041)
* docs(api-docs): add details to readme

* docs: fix wrong markdown in readme files
2020-08-20 13:57:59 +02:00
Patrik Oldsberg 02cadda870 update gitignore 2020-08-07 18:51:08 +02:00
Patrik Oldsberg f8c696e038 v0.1.1-alpha.18 2020-08-07 17:08:28 +02:00
Patrik Oldsberg 0dd8fa2828 v0.1.1-alpha.17 2020-08-05 19:36:36 +02:00
Sebastian Qvarfordt 97f3f58844 Mob/techdocs end to end (#1736)
* Initial techdocs end to end heavily inspired by scaffolder

* added some tests and fixed linting

* fix(techdocs-backend): fix eslint

* fix(techdocs-backend): cleanup commented test

* Removed unused dependency

* fix(techdocs-backend): updated standalone server

* moved type dependency to devDependencies

* fix: updated dependencies and devDependencies.

* Update plugins/techdocs-backend/src/techdocs/stages/generate/types.ts

Co-authored-by: Emma Indal <emma.indahl@gmail.com>

Co-authored-by: Emma Indal <emmai@spotify.com>
Co-authored-by: ellinors <ellinors@spotify.com>
Co-authored-by: Emma Indal <emma.indahl@gmail.com>
2020-08-04 13:04:48 +02:00
ellieseastream f38a35d6ba Merge pull request #1720 from spotify/sebastianq/techdocs-in-entity
TechDocs in entitiy model example
2020-07-27 13:27:25 +02:00
Ivan Shmidt bcd7b2661a v0.1.1-alpha.16 2020-07-24 03:44:39 +02:00
Sebastian Qvarfordt 7808c115d1 Added empty line at the end of file 2020-07-23 14:28:50 +02:00
Sebastian Qvarfordt 851b040c41 changed spotify.com namespace to backstage.io 2020-07-23 14:14:30 +02:00
Sebastian Qvarfordt 9e2606a89a feature(techdocs): added an example component in techdocs-backend containing a documentation reference 2020-07-22 16:44:14 +02:00
Ivan Shmidt 415bdf42e1 v0.1.1-alpha.15 2020-07-22 13:44:33 +02:00
Bilawal Hameed 491d1b70e1 Bump to v0.1.1-alpha.14 2020-07-15 11:49:02 +02:00
Sebastian Qvarfordt be7ef69328 Added initial scaffold for techdocs backend (#1550)
* Added initial scaffold for techdocs backend

* Added test and a dummy route

* Missed file in commit

* Removed unused dependencies

* Added readme
2020-07-07 15:37:26 +02:00