Commit Graph

303 Commits

Author SHA1 Message Date
github-actions[bot] 97420439e1 Version Packages 2021-10-07 12:17:39 +00:00
Emma Indal 156421c59a [TechDocs] Update default techdocs docker image to latest version (#7448)
* 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>
2021-10-05 13:57:55 +02:00
github-actions[bot] 6e5b1bda9d Version Packages 2021-09-23 10:01:17 +00:00
Bodil Björklund 116dc8759f Text edits for consistency and clarity
Minor edits

Signed-off-by: Bodil Björklund <bodilb@spotify.com>
2021-09-21 11:25:03 +02:00
github-actions[bot] fff5c48429 Version Packages 2021-09-16 11:41:51 +00:00
Patrik Oldsberg d0d78ebc7c Merge pull request #7181 from backstage/rugvip/descriptions
Add package descriptions + separate table for plugins in API reference
2021-09-15 17:25:27 +02:00
Jussi Hallila 9fb0503c15 Tweak lowecasing, export Optios type
Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-09-15 15:31:03 +02:00
Patrik Oldsberg 8142a8ecb2 packages,plugins: add package documentation
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-14 18:47:53 +02:00
Patrik Oldsberg 71f6356390 plugins: add package descriptions
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-14 18:33:40 +02:00
Jussi Hallila 65a2d67735 Modify fromConfig to actually use the config. Update api-reports.
Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-09-13 09:54:12 +02:00
Jussi Hallila feea75ad49 Update api-rep
Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-09-09 12:03:22 +02:00
Jussi Hallila f7c06bcadd Add some more casing changes.
Modify DefaultTechDocsCollator to have a static constructor method.

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-09-09 11:57:14 +02:00
Jussi Hallila 6f45fc7990 Modify TechDocsCollator to be aware of new urls
* Add boolean constructor param to define if to use legacy paths
* Swap urls to match new pattern
* Add few tests

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-09-03 16:00:00 +02:00
github-actions[bot] 45a681aa6a Version Packages 2021-09-02 10:41:57 +00:00
Eric Peterson dc152e0da6 Merge pull request #6773 from SDA-SE/feat/techdocs-repo-url
[Techdocs] Set the correct edit_uri or repo_url for documentation pages that are hosted on GitHub and GitLab
2021-09-01 19:11:29 +02:00
Fredrik Adelöw 1c3e45563c Merge pull request #6881 from aureliosaraiva/techdoc_title
Friendly Title for Docs
2021-09-01 10:42:02 +02:00
Eric Peterson a42a142c2f Reduce log fatigue during startup.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-08-31 15:24:04 +02:00
Aurelio Saraiva 37b29bd5a5 Merge branch 'master' into techdoc_title 2021-08-30 18:17:19 -03:00
Jussi Hallila 30ed662a35 Implement in-context search bar for tech docs. (#6651)
* Implement in-context search bar for tech docs

* Add in-context search functionality to tech docs
* Use the existing backend search functionality with tech docs specific filters
* Use material-ui autocomplete to display 10 first search results
* Add tests

Signed-off-by: Jussi Hallila <jussi@hallila.com>

* Remove context and replace it with `withSearch` prop.

Signed-off-by: Jussi Hallila <jussi@hallila.com>

* Bump search-common devp to latest

Signed-off-by: Jussi Hallila <jussi@hallila.com>

* Rename types file to not conflict with hardcoded types.d.ts.

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-08-27 12:21:48 +02:00
Dominik Henneke 8b0f6f860f Set the correct edit_uri or repo_url for documentation pages that are hosted on GitHub and GitLab
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-08-27 09:00:37 +02:00
github-actions[bot] e7130884a0 Version Packages 2021-08-26 11:25:27 +00:00
Mert Can Bilgiç 58452cdb72 OpenStack Swift SDK changed from "pkgcloud" to Trendyol's own OpenStack Swift SDK (#6839) 2021-08-25 22:16:10 +02:00
Aurelio Saraiva ce02607532 added title
Signed-off-by: Aurelio Saraiva <aureliosaraiva@gmail.com>
2021-08-18 19:02:04 -03:00
Eric Peterson 0d48fccb46 Merge branch 'master' into techdocs-common/case-sensitive-migration
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-08-12 16:28:40 +02:00
Eric Peterson 52547371fb Merge branch 'master' into techdocs-common/case-sensitive-migration
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-08-12 11:27:43 +02:00
github-actions[bot] c734d6995a Version Packages 2021-08-12 08:21:56 +00:00
Camila Belo 2f4f15846d docs(techdocs-common): add case sentitive migration steps
Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-09 12:33:28 +02:00
Fredrik Adelöw 923491eece run prettier formatting
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-08-09 11:54:38 +02:00
Camila Belo bf4ab56750 feat(techdocs-common): add legacy casing config for all providers
Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-06 11:05:31 +02:00
github-actions[bot] 326cbd7408 Version Packages 2021-08-05 00:24:56 +00:00
Eric Peterson 602b1e5c97 Update scaffolder templates to use the new, recommended annotation value.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-28 18:43:49 +02:00
github-actions[bot] f51fcaeba2 Version Packages 2021-07-22 10:52:38 +00:00
Dominik Henneke eabf5bb598 Merge remote-tracking branch 'upstream/master' into feat/relative-ref-tmp 2021-07-21 15:12:52 +02:00
Dominik Henneke ed6092f76a Handle and forward errors from the DocsBuilder instantiation to the user
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-07-21 12:42:24 +02:00
Dominik Henneke d32d01e5bc Introduce the annotation backstage.io/techdocs-ref: <relative-target> as an alias for backstage.io/techdocs-ref: dir:<relative-target>
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-07-16 10:16:32 +02:00
Jussi Hallila 9266b80ab3 Implement DefaultTechDocsCollator
* Implements a collator for tech docs.
   * Retrieves mkdocs created search index for entities that have documentation configured
* Registers collator to expose tech docs content to be searchable
* Adds pagination to example search
* Modifies example search to contain tech docs
   * Displays docs results with link to docs and the entity name as title.
* Creates a reusable type filter to be located in the search package.
* Add tests for type filter

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-07-15 13:14:25 +02:00
github-actions[bot] 8d1c3d0d5a Version Packages 2021-07-15 09:19:25 +00:00
Eric Peterson 54c25db339 Merge pull request #6071 from andrewthauer/techdocs-custom-docker
feat(techdocs-common): add custom docker image support
2021-07-15 10:39:14 +02:00
Patrik Oldsberg d9ce823b00 packages: regenerate all API reports with warnings
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-07-15 02:05:46 +02:00
Andrew Thauer d5eaab91dd feat(techdocs-common): add custom docker image support
Signed-off-by: Andrew Thauer <athauer@wealthsimple.com>
2021-07-13 11:26:17 -04:00
Dominik Henneke 386e95b94c Add missing comment
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-07-13 16:56:30 +02:00
Dominik Henneke 246b1797e5 Merge remote-tracking branch 'upstream/master' into feat/techdocs-build-logs
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-07-13 16:49:33 +02:00
Patrik Oldsberg 1118f33e4f Merge pull request #6433 from backstage/rugvip/report-all-the-things
root: bump api-extractor & friends + recreate API reports along with previously unsupported packages
2021-07-12 20:28:09 +02:00
Ben Lambert 11251fedfc Merge pull request #6442 from backstage/blam/fix-bug-with-install
Fix installs in the main repo and hopefully after release others too
2021-07-12 20:10:48 +02:00
Patrik Oldsberg 602b5b59bb packages: regenerate all API reports with prettier
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-07-12 19:54:11 +02:00
blam 203d256d36 chore: reverting fs-extra bump, that seems to have broken all the installs
Signed-off-by: blam <ben@blam.sh>
2021-07-12 19:29:34 +02:00
Eric Peterson 67d1002908 Updated API report
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-12 17:02:26 +02:00
Eric Peterson 5176099c79 Allow either out-of-the-box or recommended configurations in TechDocs createRouter
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-12 16:41:39 +02:00
Dominik Henneke 221b3080f9 Fix warning
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-07-09 14:38:50 +02:00
Dominik Henneke fbb6d421e9 Merge remote-tracking branch 'upstream/master' into feat/techdocs-build-logs 2021-07-09 14:35:01 +02:00