diff --git a/.changeset/techdocs-eight-camels-hear.md b/.changeset/techdocs-eight-camels-hear.md index 5c3df10c89..8f2479f6bd 100644 --- a/.changeset/techdocs-eight-camels-hear.md +++ b/.changeset/techdocs-eight-camels-hear.md @@ -2,6 +2,6 @@ '@backstage/plugin-techdocs': minor --- -Add feedback link icon in Techdocs Reader that directs to Gitlab or Github repo issue page with prefilled title and source link. -For link to appear, requires repo_url and edit_uri to be filled in mkdocs.yml, as per https://www.mkdocs.org/user-guide/configuration. edit_uri will need to be specified for self-hosted Gitlab/Github with different hostnames. -To identify issue URL format as Github or Gitlab, the hostname of source in repo_url is checked if it contains 'gitlab' or 'github'. Alternately this is determined by matching to 'host' values from 'integrations' in app-config.yaml. +Add feedback link icon in Techdocs Reader that directs to GitLab or GitHub repo issue page with pre-filled title and source link. +For link to appear, requires `repo_url` and `edit_uri` to be filled in mkdocs.yml, as per https://www.mkdocs.org/user-guide/configuration. An `edit_uri` will need to be specified for self-hosted GitLab/GitHub instances with a different host name. +To identify issue URL format as GitHub or GitLab, the host name of source in `repo_url` is checked if it contains `gitlab` or `github`. Alternately this is determined by matching to `host` values from `integrations` in app-config.yaml. diff --git a/docs/features/techdocs/FAQ.md b/docs/features/techdocs/FAQ.md index 3b479f2a15..117471f749 100644 --- a/docs/features/techdocs/FAQ.md +++ b/docs/features/techdocs/FAQ.md @@ -54,6 +54,6 @@ on a TechDocs page, be sure that you have `repo_url` and `edit_uri` values in your `mkdocs.yml` files per [MkDocs instructions](https://www.mkdocs.org/user-guide/configuration). -If the hostname of your source code hosting URL does not include 'github' or -'gitlab', an `integrations` entry in your `app-config.yaml` pointed at your +If the host name of your source code hosting URL does not include `github` or +`gitlab`, an `integrations` entry in your `app-config.yaml` pointed at your source code provider is also needed (only the `host` key is necessary).