From 68d71aac2e7669100287ae3817f3e7e1e999cfc0 Mon Sep 17 00:00:00 2001 From: "Ross Buggins (NHS)" Date: Fri, 7 Jun 2024 08:57:18 +0100 Subject: [PATCH] Workspace file (#19) * added workspace file back * Workspace to only docs. --- .devcontainer/devcontainer.json | 17 ++--- .github/CODEOWNERS | 19 ++++++ .gitignore | 2 +- .vscode/extensions.json | 36 ----------- .vscode/settings.json | 7 --- {.vscode => docs/.vscode}/launch.json | 0 {.vscode => docs/.vscode}/tasks.json | 4 +- docs/Makefile | 17 +++++ docs/README.md | 3 + docs/_config.yml | 28 +++++---- docs/package.json | 15 +++++ nhs-notify-web-cms.code-workspace | 89 +++++++++++++++++++++++++++ 12 files changed, 166 insertions(+), 71 deletions(-) create mode 100644 .github/CODEOWNERS delete mode 100644 .vscode/extensions.json delete mode 100644 .vscode/settings.json rename {.vscode => docs/.vscode}/launch.json (100%) rename {.vscode => docs/.vscode}/tasks.json (50%) create mode 100644 docs/Makefile create mode 100644 docs/README.md create mode 100644 docs/package.json create mode 100644 nhs-notify-web-cms.code-workspace diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index dd99073..dd1f110 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -15,21 +15,11 @@ // Configure tool-specific properties. "customizations": { "codespaces": { - "openFiles": [ - "README.md", - ".github/SECURITY.md", - "docs/index.md" - ] + "openFiles": ["README.md", ".github/SECURITY.md", "docs/pages/index.md"] }, "vscode": { // Set *default* container specific settings.json values on container create. "settings": { - "editor.formatOnSave": true, - "files.insertFinalNewline": true, - "[makefile]": { - "editor.insertSpaces": false, - "editor.detectIndentation": false - } }, // Add the IDs of extensions you want installed when the container is created. "extensions": [ @@ -63,7 +53,10 @@ "wayou.vscode-todo-highlight", "yzane.markdown-pdf", "yzhang.dictionary-completion", - "yzhang.markdown-all-in-one" + "yzhang.markdown-all-in-one", + "joshx.workspace-terminals", + "takumii.markdowntable", + "chdsbd.github-code-owners" ] } }, diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..83981a7 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,19 @@ +# NHS Notify Code Owners + +* @NHSDigital/nhs-notify-amet + +/.github/ @NHSDigital/nhs-notify-amet +*.code-workspace @NHSDigital/nhs-notify-amet + +/docs/ @NHSDigital/nhs-notify-amet +/docs/_sass/ @NHSDigital/nhs-notify-web-cms +/docs/_includes/ @NHSDigital/nhs-notify-web-cms +/docs/_layouts/ @NHSDigital/nhs-notify-web-cms +/docs/pages/ @NHSDigital/nhs-notify-web-cms +/docs/collections/ @NHSDigital/nhs-notify-web-cms +/docs/_config.yml @NHSDigital/nhs-notify-web-cms +/docs/_config.dev.yml @NHSDigital/nhs-notify-web-cms + +# Default protection for codeowners, must be last in file. +/.github/CODEOWNERS @NHSDigital/nhs-notify-code-owners +/CODEOWNERS @NHSDigital/nhs-notify-code-owners diff --git a/.gitignore b/.gitignore index 5c974d2..c3cd2e6 100644 --- a/.gitignore +++ b/.gitignore @@ -12,4 +12,4 @@ # Please, add your custom content below! -nhs-notify-web-cms.code-workspace +!nhs-notify-web-cms.code-workspace diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index 957d73f..0000000 --- a/.vscode/extensions.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "recommendations": [ - "alefragnani.bookmarks", - "davidanson.vscode-markdownlint", - "dbaeumer.vscode-eslint", - "donjayamanne.githistory", - "eamodio.gitlens", - "editorconfig.editorconfig", - "esbenp.prettier-vscode", - "github.codespaces", - "github.github-vscode-theme", - "github.remotehub", - "github.vscode-github-actions", - "github.vscode-pull-request-github", - "hediet.vscode-drawio", - "johnpapa.vscode-peacock", - "mhutchie.git-graph", - "ms-azuretools.vscode-docker", - "ms-vscode-remote.remote-containers", - "ms-vscode-remote.remote-wsl", - "ms-vscode.hexeditor", - "ms-vscode.live-server", - "ms-vsliveshare.vsliveshare", - "redhat.vscode-xml", - "streetsidesoftware.code-spell-checker-british-english", - "tamasfe.even-better-toml", - "tomoki1207.pdf", - "vscode-icons-team.vscode-icons", - "vstirbu.vscode-mermaid-preview", - "wayou.vscode-todo-highlight", - "yzane.markdown-pdf", - "yzhang.dictionary-completion", - "yzhang.markdown-all-in-one" - ], - "unwantedRecommendations": [] -} diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index 423458c..0000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "markdownlint.config": { - "MD013": false, - "MD024": { "siblings_only": true }, - "MD033": false - } -} diff --git a/.vscode/launch.json b/docs/.vscode/launch.json similarity index 100% rename from .vscode/launch.json rename to docs/.vscode/launch.json diff --git a/.vscode/tasks.json b/docs/.vscode/tasks.json similarity index 50% rename from .vscode/tasks.json rename to docs/.vscode/tasks.json index 5644eab..ba15193 100644 --- a/.vscode/tasks.json +++ b/docs/.vscode/tasks.json @@ -4,9 +4,9 @@ { "label": "jekyll", "options": { - "cwd": "${workspaceFolder}/docs/" + "cwd": "${workspaceFolder}" }, - "command": "bundle exec jekyll serve --config _config.yml,_config.dev.yml", + "command": "make debug", "type": "shell" } ] diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..b4d072a --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,17 @@ +default: install + +h help: + @egrep '^\S|^$$' Makefile + +install: + bundle config set --local path vendor/bundle + bundle install + +s serve: + bundle exec jekyll serve --trace --livereload + +build: + JEKYLL_ENV=production bundle exec jekyll build --trace + +debug: + npm run debug diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..e4ad93b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,3 @@ +# Developer info for Public Website + +Document here. diff --git a/docs/_config.yml b/docs/_config.yml index db4c542..720eddf 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -45,14 +45,14 @@ mermaid: aux_links: "NHS Notify on GitHub": - - "//github.com/NHSDigital/nhs-notify" + - "//github.com/NHSDigital/nhs-notify-web-cms" aux_links_new_tab: false # Footer "Edit this page on GitHub" link text gh_edit_link: true # show or hide edit this page link gh_edit_link_text: "Edit this page on GitHub." -gh_edit_repository: "https://github.com/NHSDigital/nhs-notify" # the github URL for your repo +gh_edit_repository: "https://github.com/NHSDigital/nhs-notify-web-cms" # the github URL for your repo 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 @@ -76,14 +76,16 @@ callouts: # 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/ +exclude: + - .vscode/ + - README.md + - .sass-cache/ + - .jekyll-cache/ + - gemfiles/ + - Gemfile + - Gemfile.lock + - node_modules/ + - vendor/bundle/ + - vendor/cache/ + - vendor/gems/ + - vendor/ruby/ diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 0000000..66b41e5 --- /dev/null +++ b/docs/package.json @@ -0,0 +1,15 @@ +{ + "name": "nhs-notify-web-cms", + "version": "1.0.0", + "description": "", + "private": true, + "engines": {}, + "scripts": { + "debug": "JEKYLL_ENV=development BUNDLE_GEMFILE=Gemfile bundle exec jekyll serve --config _config.yml,_config.dev.yml --limit_posts 100 --trace --livereload" + }, + "keywords": [], + "author": "", + "license": "ISC", + "devDependencies": {}, + "dependencies": {} +} diff --git a/nhs-notify-web-cms.code-workspace b/nhs-notify-web-cms.code-workspace new file mode 100644 index 0000000..d22e5d7 --- /dev/null +++ b/nhs-notify-web-cms.code-workspace @@ -0,0 +1,89 @@ +{ + "folders": [ + { + "name": "NHS Notify Web CMS Public Website", + "path": "docs" + } + ], + "settings": { + "githubCodeOwners.format.enabled": true, + "workspace-terminals.switchTerminal": "always", + "workspace-terminals.auto": "always", + "markdownlint.config": { + "MD013": false, + "MD024": { "siblings_only": true }, + "MD033": false + }, + "cSpell.words": [ + "ADRS", + "Amaan", + "Codespaces", + "endfor", + "Nasar", + "preinstalled", + "pythonist", + "rossbugginsnhs", + "ruleset", + "Stefaniuk" + ], + "cSpell.language": "en-GB", + "editor.wordWrap": "off", + "editor.formatOnSave": true, + "[markdown]": { + "editor.wordWrap": "off", + "editor.defaultFormatter": "esbenp.prettier-vscode" + }, + "[jsonc]": { + "editor.defaultFormatter": "esbenp.prettier-vscode" + }, + "[html]": { + "editor.defaultFormatter": "vscode.html-language-features" + }, + "[json]": { + "editor.defaultFormatter": "esbenp.prettier-vscode" + }, + "files.exclude": { + "**/_site": true, + "**/.jekyll-cache": true + } + }, + "extensions": { + "recommendations": [ + "alefragnani.bookmarks", + "davidanson.vscode-markdownlint", + "dbaeumer.vscode-eslint", + "donjayamanne.githistory", + "eamodio.gitlens", + "editorconfig.editorconfig", + "esbenp.prettier-vscode", + "github.codespaces", + "github.github-vscode-theme", + "github.remotehub", + "github.vscode-github-actions", + "github.vscode-pull-request-github", + "hediet.vscode-drawio", + "johnpapa.vscode-peacock", + "mhutchie.git-graph", + "ms-azuretools.vscode-docker", + "ms-vscode-remote.remote-containers", + "ms-vscode-remote.remote-wsl", + "ms-vscode.hexeditor", + "ms-vscode.live-server", + "ms-vsliveshare.vsliveshare", + "redhat.vscode-xml", + "streetsidesoftware.code-spell-checker-british-english", + "tamasfe.even-better-toml", + "tomoki1207.pdf", + "vscode-icons-team.vscode-icons", + "vstirbu.vscode-mermaid-preview", + "wayou.vscode-todo-highlight", + "yzane.markdown-pdf", + "yzhang.dictionary-completion", + "yzhang.markdown-all-in-one", + "joshx.workspace-terminals", + "takumii.markdowntable", + "chdsbd.github-code-owners" + ], + "unwantedRecommendations": [] + } +}