diff --git a/docs/_config.yml b/docs/_config.yml index 5f0ea7b..c4fef98 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -21,22 +21,15 @@ title: NHS Notify Tech Docs # email: your-email@example.com description: >- # this means to ignore newlines until "baseurl:" - Write an awesome description for your new site here. You can edit this - line in _config.yml. It will appear in your document head meta (for - Google search results) and in your feed.xml site description. + Technical documentation for the NHS Notify Platform. baseurl: "/nhs-notify" # the subpath of your site, e.g. /blog url: "https://nhsdigital.github.io" # the base hostname & protocol for your site, e.g. http://example.com -twitter_username: jekyllrb -github_username: jekyll # Build settings theme: just-the-docs plugins: - jekyll-feed -header_pages: - - about.md - color_scheme: nhs mermaid: # Version of mermaid library @@ -57,6 +50,23 @@ gh_edit_branch: "main" # the branch that your docs is served from # gh_edit_source: docs # the source that your files originate from gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately +nav_external_links: + - title: Notify Service Catalogue + url: https://digital.nhs.uk/services/nhs-notify + hide_icon: false # set to true to hide the external link icon - defaults to false + opens_in_new_tab: false # set to true to open this link in a new tab - defaults to false + + - title: Notify Dns Tech Docs + url: https://nhsdigital.github.io/nhs-notify-dns/ + hide_icon: false # set to true to hide the external link icon - defaults to false + opens_in_new_tab: false # set to true to open this link in a new tab - defaults to false + + - title: NHS SEQF + url: https://github.com/NHSDigital/software-engineering-quality-framework + hide_icon: false # set to true to hide the external link icon - defaults to false + opens_in_new_tab: false # set to true to open this link in a new tab - defaults to false + + callouts: warning: title: Warning diff --git a/docs/index.md b/docs/index.md index c1e9873..5a581da 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,7 +7,7 @@ title: Home nav_order: 1 --- -[![CI/CD Pull Request](https://github.com/NHSDigital/nhs-notify/actions/workflows/cicd-1-pull-request.yaml/badge.svg)](https://github.com/NHSDigital/nhs-notify/actions/workflows/cicd-1-pull-request.yaml) +[![CI/CD Pull Request](https://github.com/NHSDigital/nhs-notify/actions/workflows/jekyll-gh-pages.yml/badge.svg)](https://github.com/NHSDigital/nhs-notify/actions/workflows/jekyll-gh-pages.yml) NHS Notify - for the NHS Notify web site, onboarding guidance, and customer support, please visit the [NHS Service Catalogue](https://digital.nhs.uk/services/nhs-notify). @@ -21,7 +21,7 @@ NHS Notify - for the NHS Notify web site, onboarding guidance, and customer supp - NHS Developers working on NHS Notify - Those who are interested in NHS Notify architecture and how it is developed. -## Who/what is this repository not for? +## Who/what is this repository **not** for? - Customer Support - Supplier Support @@ -39,7 +39,7 @@ NHS Notify - for the NHS Notify web site, onboarding guidance, and customer supp - [Related Repos](#related-repos) - [Who/what is this repository is for?](#whowhat-is-this-repository-is-for) -- [Who/what is this repository not for?](#whowhat-is-this-repository-not-for) +- [Who/what is this repository **not** for?](#whowhat-is-this-repository-not-for) - [What this repo contains](#what-this-repo-contains) - [What this repo does not contain](#what-this-repo-does-not-contain) - [Table of Contents](#table-of-contents)