Skip to content

Commit

Permalink
V0.1.1 alpha (#3)
Browse files Browse the repository at this point in the history
* Initial folder strucuture.

* Added headings to account design.

* Adding to base readme.

Signed-off-by: Ross Buggins <[email protected]>

* Correct experience spelling.

Signed-off-by: Ross Buggins <[email protected]>

* Added nhs-account.drawio

* Added experimental .svg export of .drawio files. Currently a manual process.

Signed-off-by: Ross Buggins <[email protected]>

* Added Gov Open 3 licence. copied from https://github.com/nhsx/open-source-policy/blob/main/LICENCE

Signed-off-by: Ross Buggins <[email protected]>

* Renamed licence to license.

Signed-off-by: Ross Buggins <[email protected]>

* Testing mermaid.

Signed-off-by: Ross Buggins <[email protected]>

* Added what is account from briefing.

Signed-off-by: Ross Buggins <[email protected]>

* test jekyll.

Signed-off-by: Ross Buggins <[email protected]>

* ci: add Azure Static Web Apps workflow file
on-behalf-of: @Azure [email protected]

* Update azure-static-web-apps-blue-beach-03e72e403.yml

* Update azure-static-web-apps-blue-beach-03e72e403.yml

* Update azure-static-web-apps-blue-beach-03e72e403.yml

* Update azure-static-web-apps-blue-beach-03e72e403.yml

* Update azure-static-web-apps-blue-beach-03e72e403.yml

* Update azure-static-web-apps-blue-beach-03e72e403.yml

* Base jekyll.

Signed-off-by: Ross Buggins <[email protected]>

* Base jekyll.

Signed-off-by: Ross Buggins <[email protected]>

* Jekyll config file.

Signed-off-by: Ross Buggins <[email protected]>

* Jekyll config file.

Signed-off-by: Ross Buggins <[email protected]>

* Add some pages.

Signed-off-by: Ross Buggins <[email protected]>

* Added jekyll custom menu theme.

Signed-off-by: Ross Buggins <[email protected]>

* Use .svg instead of .drawio in the docs files.

Signed-off-by: Ross Buggins <[email protected]>

* Changed theme to https://github.com/just-the-docs/just-the-docs.

Signed-off-by: Ross Buggins <[email protected]>

* Mermaid working, changed index to readme.

Signed-off-by: Ross Buggins <[email protected]>

* Addeded index back.

Signed-off-by: Ross Buggins <[email protected]>

* Sorted table.

Signed-off-by: Ross Buggins <[email protected]>

* Add Git process page.

Signed-off-by: Ross Buggins <[email protected]>

* Version v0.1-aplha for PR to upstream.

Signed-off-by: Ross Buggins <[email protected]>

* Change github workflow to main.

Signed-off-by: Ross Buggins <[email protected]>

* removed gemfile lock

Signed-off-by: Ross Buggins <[email protected]>

* removed old jekyll folder.

Signed-off-by: Ross Buggins <[email protected]>
  • Loading branch information
RossBugginsNHS authored Jul 13, 2022
1 parent 4664986 commit 7461a2d
Show file tree
Hide file tree
Showing 25 changed files with 568 additions and 1 deletion.
8 changes: 8 additions & 0 deletions AboutCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
> ⚠️ **Warning**
>
> **Draft Documents**: May not represent real world scenarios, may not be fully accurate or complete.
>
> Please contact the author for more information.

# About Citizen Experience
2 changes: 2 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# The NHS constitutional values
https://www.hee.nhs.uk/about/our-values/nhs-constitutional-values-hub-0
69 changes: 69 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
Open Government Licence v3.0

You are encouraged to use and re-use the Information that is available under this licence freely and flexibly, with only a few conditions.

Using Information under this licence
Use of copyright and database right material expressly made available under this licence (the 'Information') indicates your acceptance of the terms and conditions below.

The Licensor grants you a worldwide, royalty-free, perpetual, non-exclusive licence to use the Information subject to the conditions below.

This licence does not affect your freedom under fair dealing or fair use or any other copyright or database right exceptions and limitations.

You are free to:
copy, publish, distribute and transmit the Information;
adapt the Information;
exploit the Information commercially and non-commercially for example, by combining it with other Information, or by including it in your own product or application.
You must (where you do any of the above):
acknowledge the source of the Information in your product or application by including or linking to any attribution statement specified by the Information Provider(s) and, where possible, provide a link to this licence;
If the Information Provider does not provide a specific attribution statement, you must use the following:

Contains public sector information licensed under the Open Government Licence v3.0.

If you are using Information from several Information Providers and listing multiple attributions is not practical in your product or application, you may include a URI or hyperlink to a resource that contains the required attribution statements.

These are important conditions of this licence and if you fail to comply with them the rights granted to you under this licence, or any similar licence granted by the Licensor, will end automatically.

Exemptions
This licence does not cover:

personal data in the Information;
Information that has not been accessed by way of publication or disclosure under information access legislation (including the Freedom of Information Acts for the UK and Scotland) by or with the consent of the Information Provider;
departmental or public sector organisation logos, crests and the Royal Arms except where they form an integral part of a document or dataset;
military insignia;
third party rights the Information Provider is not authorised to license;
other intellectual property rights, including patents, trade marks, and design rights; and
identity documents such as the British Passport
Non-endorsement
This licence does not grant you any right to use the Information in a way that suggests any official status or that the Information Provider and/or Licensor endorse you or your use of the Information.

No warranty
The Information is licensed 'as is' and the Information Provider and/or Licensor excludes all representations, warranties, obligations and liabilities in relation to the Information to the maximum extent permitted by law.

The Information Provider and/or Licensor are not liable for any errors or omissions in the Information and shall not be liable for any loss, injury or damage of any kind caused by its use. The Information Provider does not guarantee the continued supply of the Information.

Governing Law
This licence is governed by the laws of the jurisdiction in which the Information Provider has its principal place of business, unless otherwise specified by the Information Provider.

Definitions
In this licence, the terms below have the following meanings:

'Information' means information protected by copyright or by database right (for example, literary and artistic works, content, data and source code) offered for use under the terms of this licence.

'Information Provider' means the person or organisation providing the Information under this licence.

'Licensor' means any Information Provider which has the authority to offer Information under the terms of this licence or the Keeper of Public Records, who has the authority to offer Information subject to Crown copyright and Crown database rights and Information subject to copyright and database right that has been assigned to or acquired by the Crown, under the terms of this licence.

'Use' means doing any act which is restricted by copyright or database right, whether in the original medium or in any other medium, and includes without limitation distributing, copying, adapting, modifying as may be technically necessary to use it in a different mode or format.

'You', 'you' and 'your' means the natural or legal person, or body of persons corporate or incorporate, acquiring rights in the Information (whether the Information is obtained directly from the Licensor or otherwise) under this licence.

About the Open Government Licence
The National Archives has developed this licence as a tool to enable Information Providers in the public sector to license the use and re-use of their Information under a common open licence. The National Archives invites public sector bodies owning their own copyright and database rights to permit the use of their Information under this licence.

The Keeper of the Public Records has authority to license Information subject to copyright and database right owned by the Crown. The extent of the offer to license this Information under the terms of this licence is set out in the UK Government Licensing Framework.

This is version 3.0 of the Open Government Licence. The National Archives may, from time to time, issue new versions of the Open Government Licence. If you are already using Information under a previous version of the Open Government Licence, the terms of that licence will continue to apply.

These terms are compatible with the Creative Commons Attribution License 4.0 and the Open Data Commons Attribution License, both of which license copyright and database rights. This means that when the Information is adapted and licensed under either of those licences, you automatically satisfy the conditions of the OGL when you comply with the other licence. The OGLv3.0 is Open Definition compliant.

Further context, best practice and guidance can be found in the UK Government Licensing Framework section on The National Archives website.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# architecture-design-docs
> ⚠️ **Warning**
>
> **Draft Documents**: May not represent real world scenarios, may not be fully accurate or complete.
>
> Please contact the author for more information.
# Citizen Experience

[See docs](/docs/README.md)
13 changes: 13 additions & 0 deletions contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
> ⚠️ **Warning**
>
> **Draft Documents**: May not represent real world scenarios, may not be fully accurate or complete.
>
> Please contact the author for more information.
# Fallback contact
Ross Buggins | Citizen Experience | NHSE/I

[Git Hub Contact me](https://github.com/RossBugginsNHS/contact-me/issues/new?assignees=RossBugginsNHS&labels=contact&template=contact-me-template.yaml&title=%5BContact%5D%3A+Citizen%20Experience%20Contact)

[email protected]

Empty file added contents.md
Empty file.
7 changes: 7 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
_site
.sass-cache
.jekyll-cache
.jekyll-metadata
vendor
.lock
Gemfile.lock
25 changes: 25 additions & 0 deletions docs/404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
permalink: /404.html
layout: default
---

<style type="text/css" media="screen">
.container {
margin: 10px auto;
max-width: 600px;
text-align: center;
}
h1 {
margin: 30px 0;
font-size: 4em;
line-height: 1;
letter-spacing: -1px;
}
</style>

<div class="container">
<h1>404</h1>

<p><strong>Page not found :(</strong></p>
<p>The requested page could not be found.</p>
</div>
35 changes: 35 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
source "https://rubygems.org"
# Hello! This is where you manage which Jekyll version is used to run.
# When you want to use a different version, change it below, save the
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
#
# bundle exec jekyll serve
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
gem "jekyll", "~> 4.2.2"
# This is the default theme for new Jekyll sites. You may change this to anything you like.
#gem "minima", "~> 2.5"
gem "just-the-docs"
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
# gem "github-pages", group: :jekyll_plugins
# If you have any plugins, put them here!
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.12"
#gem "jekyll-drawio", "~> 0.0.6", path: "/home/rb/source/jekyll-drawio"
end

# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", "~> 1.2"
gem "tzinfo-data"
end

# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]

# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
# do not have a Java counterpart.
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[See docs](/docs/index.md)
55 changes: 55 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
#
# If you need help with YAML syntax, here are some quick references for you:
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
# https://learnxinyminutes.com/docs/yaml/
#
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.

title: NHS Citizen Experience - NHS Transformation Directorate, NHS England and Improvement
email:
description: >- # this means to ignore newlines until "baseurl:"
Give patients, service users and carers the tools to access information and services directly
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com
twitter_username:
github_username: nhsexperience

# Build settings
theme: just-the-docs
plugins:
- jekyll-feed



# Exclude from processing.
# The following items will not be processed, by default.
# Any item listed under the `exclude:` key here will be automatically added to
# the internal "default list".
#
# Excluded items can be processed by explicitly listing the directories or
# their entries' file path in the `include:` list.
#
# exclude:
# - .sass-cache/
# - .jekyll-cache/
# - gemfiles/
# - Gemfile
# - Gemfile.lock
# - node_modules/
# - vendor/bundle/
# - vendor/cache/
# - vendor/gems/
# - vendor/ruby/
4 changes: 4 additions & 0 deletions docs/_includes/head_custom.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{% if page.mermaid %}
{% include mermaid.html %}
{% endif %}

10 changes: 10 additions & 0 deletions docs/_includes/mermaid.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<script src="https://unpkg.com/[email protected]/dist/mermaid.min.js"></script>
<script>
$(document).ready(function () {
mermaid.initialize({
startOnLoad:true,
theme: "default",
});
window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
});
</script>
22 changes: 22 additions & 0 deletions docs/citizen-experience/reference-architecture/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Reference Architecture
layout: page
permalink: /ref-arch/
nav_order: 4
---


> ⚠️ **Warning**
>
> **Draft Documents**: May not represent real world scenarios, may not be fully accurate or complete.
>
> Please contact the author for more information.
# Architectural Guidelines

# APIs
## Performance

# UIs

# Services
33 changes: 33 additions & 0 deletions docs/digital-health-check/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: NHS Digital Health Check
layout: page
permalink: /healthcheck/index.html
has_children: true
nav_order: 3
---

> ⚠️ **Warning**
>
> **Draft Documents**: May not represent real world scenarios, may not be fully accurate or complete.
>
> Please contact the author for more information.

# Digital Health Check

## Mandate - Why this is being done?

## Current Status

| Stage | Date Started | Est End Date | End Date |
| --------- | ------------ | ------------ | -------- |
| Discovery | June 2022 | August 2022 | |

## Discovery


## Alpha

## Beta

## Production
13 changes: 13 additions & 0 deletions docs/digital-health-check/discovery-technical.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: DHC Discovery - Technical
layout: page
permalink: /healthcheck/discovery-technical.html
parent: NHS Digital Health Check
nav_order: 2
---

> ⚠️ **Warning**
>
> **Draft Documents**: May not represent real world scenarios, may not be fully accurate or complete.
>
> Please contact the author for more information.
7 changes: 7 additions & 0 deletions docs/gov/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Goverment Process
layout: page
nav_order: 6
---

- Gov.uk agile process - https://www.gov.uk/service-manual/agile-delivery
33 changes: 33 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Home
layout: home
nav_order: 1
---
> ⚠️ **Warning**
>
> **Draft Documents**: May not represent real world scenarios, may not be fully accurate or complete.
>
> Please contact the author for more information.
# Todo:

- Add documentation framework
- Auto build .drawio to .svg

# Citizen Experience

## Open Source Location

| | Source and build details |
| :------------------------ | :----------------------------------------------- |
| Owner | nhsexperience |
| Repo | nhs-experience |
| Branch | main |
| Link | https://github.com/nhsexperience/nhs-experience/ |
| Site | n/a |
| Latest Release | Test release v0.1.0-alpha |
| Latest Release Tag | v0.1.0-alpha |
| Latest Stable Release | n/a |
| Latest Stable Release Tag | n/a |

- [Latest Release](https://github.com/nhsexperience/nhs-experience/releases/latest)
- ![Azure CI/CD](https://github.com/nhsexperience/nhs-experience/actions/workflows/[FILENAMEHERE]/badge.svg?branch=initial-setup)
Loading

0 comments on commit 7461a2d

Please sign in to comment.