So far, none of the components at the uffizzi environment have techdocs.
Hence, there are no docs available within this environment
and related features are not covered.
This change will add an example from techdocs-backend plugin
to the deployed examples.
It was possible to register this catalog file manually,
however the build of the docs fail due to missing Docker.
To allow the generation of docs, we use the local generator
(no docker in docker) and install required dependencies.
As we don't want all dependencies for all (default) extensions
to be installed at this environment, the original example at
techdocs-backend plugin was copied and reduced
(PlantUML extension example was removed).
Signed-off-by: Patrick Jungermann <Patrick.Jungermann@gmail.com>
* set default docker image to latest one 0.3.3
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
* update extensions docs with new truly sane lists example
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
* changeset
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
* use consistent tagging for docker image versions
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
* update changeset with correct link to tag
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
* update api report
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
Follow up for #5073
Instead of disabling prettier completely, I would prefer to disable it for the lines that actual cause issues.
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
It is time to start using URL Reader for the exmaple docs components we provide in the out-of-the-box experience (i.e. when users experience TechDocs by doing a git clone of this repository).
URL Reader makes the prepare step 8x faster.
* 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>
* 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>
Stephen A. Wilson