From 52fff5ed0be098ddf95d6eedfaad30bf1fe0f3f2 Mon Sep 17 00:00:00 2001 From: Antonino Provenzano Date: Tue, 14 Nov 2023 10:49:21 +0100 Subject: [PATCH 1/5] Update how-to-guides.md Added new section in doc, to prevent download of Google fonts Signed-off-by: Antonino Provenzano --- docs/features/techdocs/how-to-guides.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/features/techdocs/how-to-guides.md b/docs/features/techdocs/how-to-guides.md index 29f985904f..8415640569 100644 --- a/docs/features/techdocs/how-to-guides.md +++ b/docs/features/techdocs/how-to-guides.md @@ -483,6 +483,8 @@ plugins: - techdocs-core ``` +note: + 3. Create a `/docs` folder in the skeleton folder with at least an `index.md` file in it. @@ -504,6 +506,18 @@ folder (/docs) or replace the content in this file. Done! You now have support for TechDocs in your own software template! +### Prevent download of Google fonts + +If your Backstage instance does not have internet access, the generation will fail. TechDocs tries to download the Roboto font from Google. You can disable it by adding the following lines to mkdocs.yaml: + +```markdown +theme: + name: material + font: false +``` + +note: The addition "name material" is necessary. Otherwise it will not work + ## How to enable iframes in TechDocs TechDocs uses the [DOMPurify](https://github.com/cure53/DOMPurify) library to From 01594ee027bcc32a62d56201122fe0a90d4672f0 Mon Sep 17 00:00:00 2001 From: Antonino Provenzano Date: Fri, 17 Nov 2023 13:46:12 +0100 Subject: [PATCH 2/5] Update docs/features/techdocs/how-to-guides.md Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com> Signed-off-by: Antonino Provenzano --- docs/features/techdocs/how-to-guides.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/techdocs/how-to-guides.md b/docs/features/techdocs/how-to-guides.md index 8415640569..a71e656226 100644 --- a/docs/features/techdocs/how-to-guides.md +++ b/docs/features/techdocs/how-to-guides.md @@ -516,7 +516,7 @@ theme: font: false ``` -note: The addition "name material" is necessary. Otherwise it will not work +> Note: The addition `name: material` is necessary. Otherwise it will not work ## How to enable iframes in TechDocs From fcc90e9d15d316ac4a6e45db53e8698463861947 Mon Sep 17 00:00:00 2001 From: Antonino Provenzano Date: Fri, 17 Nov 2023 15:09:13 +0100 Subject: [PATCH 3/5] Update accept.txt Added "Roboto" in file Signed-off-by: Antonino Provenzano --- .github/vale/Vocab/Backstage/accept.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/vale/Vocab/Backstage/accept.txt b/.github/vale/Vocab/Backstage/accept.txt index 73f6d56bb4..8a778fc5fe 100644 --- a/.github/vale/Vocab/Backstage/accept.txt +++ b/.github/vale/Vocab/Backstage/accept.txt @@ -323,6 +323,7 @@ reusability Reusability roadmaps rollbar +Roboto Rollbar Rollup routable From 286b6f90c3deea0e547c41defa2bb9e5e9096b76 Mon Sep 17 00:00:00 2001 From: Antonino Provenzano Date: Fri, 17 Nov 2023 15:13:31 +0100 Subject: [PATCH 4/5] Update how-to-guides.md Removed "note:". It was a mistake Signed-off-by: Antonino Provenzano --- docs/features/techdocs/how-to-guides.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/features/techdocs/how-to-guides.md b/docs/features/techdocs/how-to-guides.md index a71e656226..4a562dd1c0 100644 --- a/docs/features/techdocs/how-to-guides.md +++ b/docs/features/techdocs/how-to-guides.md @@ -483,8 +483,6 @@ plugins: - techdocs-core ``` -note: - 3. Create a `/docs` folder in the skeleton folder with at least an `index.md` file in it. From c8e253a2e8dd8a4a99314e8902fe3dce72f0f84b Mon Sep 17 00:00:00 2001 From: Andre Wanlin <67169551+awanlin@users.noreply.github.com> Date: Sat, 2 Dec 2023 06:12:01 -0600 Subject: [PATCH 5/5] Update docs/features/techdocs/how-to-guides.md Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com> --- docs/features/techdocs/how-to-guides.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/techdocs/how-to-guides.md b/docs/features/techdocs/how-to-guides.md index 4a562dd1c0..afc257f20b 100644 --- a/docs/features/techdocs/how-to-guides.md +++ b/docs/features/techdocs/how-to-guides.md @@ -508,7 +508,7 @@ Done! You now have support for TechDocs in your own software template! If your Backstage instance does not have internet access, the generation will fail. TechDocs tries to download the Roboto font from Google. You can disable it by adding the following lines to mkdocs.yaml: -```markdown +```yaml theme: name: material font: false