From 37425adb44111b04b814336fafd1c5f1ecf5cca6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrea=20Sz=C3=B6ll=C3=B6ssi?= Date: Mon, 28 Oct 2019 16:07:43 +0000 Subject: [PATCH 1/4] 'Support' header link to go to 'Support' docs section There is now a section in the docs about support so the geader link should go there. --- config/tech-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/tech-docs.yml b/config/tech-docs.yml index bba232f..e346fc1 100644 --- a/config/tech-docs.yml +++ b/config/tech-docs.yml @@ -11,7 +11,7 @@ phase: Beta header_links: About: https://sites.google.com/a/digital.cabinet-office.gov.uk/gds/communities-of-practice/content/technical-writing Documentation: / - Support: / + Support: /support # Table of contents depth – how many levels to include in the table of contents. # If your ToC is too long, reduce this number and we'll only show higher-level From 481ff74593110889ac2ff21be78be2e5a18da466 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrea=20Sz=C3=B6ll=C3=B6ssi?= Date: Mon, 28 Oct 2019 16:10:58 +0000 Subject: [PATCH 2/4] Delete 'Documentation' header link This header link makes sense if there's a common header for the product page and the docs. However in this case we don't have a product page so only having the link in the docs is not useful. --- config/tech-docs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/config/tech-docs.yml b/config/tech-docs.yml index e346fc1..3c3e4ce 100644 --- a/config/tech-docs.yml +++ b/config/tech-docs.yml @@ -10,7 +10,6 @@ phase: Beta # Links to show on right-hand-side of header header_links: About: https://sites.google.com/a/digital.cabinet-office.gov.uk/gds/communities-of-practice/content/technical-writing - Documentation: / Support: /support # Table of contents depth – how many levels to include in the table of contents. From 60e039059cdda344081d22543f75159c7b0822aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrea=20Sz=C3=B6ll=C3=B6ssi?= Date: Mon, 28 Oct 2019 16:12:55 +0000 Subject: [PATCH 3/4] Remove 'About' link to GDS wiki The tdt-documentation is for users across government which means there is a group of users who won't be able to access the About link. If we want to keep the link to the GDS wiki, it should be somewhere less proeminent. --- config/tech-docs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/config/tech-docs.yml b/config/tech-docs.yml index 3c3e4ce..8b5666f 100644 --- a/config/tech-docs.yml +++ b/config/tech-docs.yml @@ -9,7 +9,6 @@ phase: Beta # Links to show on right-hand-side of header header_links: - About: https://sites.google.com/a/digital.cabinet-office.gov.uk/gds/communities-of-practice/content/technical-writing Support: /support # Table of contents depth – how many levels to include in the table of contents. From 091ba9801bb3dbd68276664eba435cac956a04ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrea=20Sz=C3=B6ll=C3=B6ssi?= Date: Mon, 28 Oct 2019 16:20:04 +0000 Subject: [PATCH 4/4] Add header links to the template and the gem These would be useful if users want to quickly go to the template or the gem, which is quite frequent in my experience. --- config/tech-docs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/config/tech-docs.yml b/config/tech-docs.yml index 8b5666f..a50f58e 100644 --- a/config/tech-docs.yml +++ b/config/tech-docs.yml @@ -9,6 +9,8 @@ phase: Beta # Links to show on right-hand-side of header header_links: + Template: https://github.com/alphagov/tech-docs-template + Ruby gem: https://github.com/alphagov/tech-docs-gem Support: /support # Table of contents depth – how many levels to include in the table of contents.