Skip to content

Commit

Permalink
Merge branch 'master' into sarah-branch
Browse files Browse the repository at this point in the history
  • Loading branch information
Sarah-Lombardi authored Aug 2, 2024
2 parents 6834cf5 + b471cb6 commit 23305ac
Show file tree
Hide file tree
Showing 26 changed files with 310 additions and 51 deletions.
2 changes: 1 addition & 1 deletion .github/actions/deploy-to-heroku/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ runs:
steps:

- name: Login to Heroku
uses: AkhileshNS/heroku-deploy@v3.12.14
uses: AkhileshNS/heroku-deploy@v3.13.15
with:
heroku_api_key: ${{ inputs.heroku-api-key }}
heroku_app_name: ''
Expand Down
2 changes: 1 addition & 1 deletion .github/actions/deploy-to-netlify/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ runs:

- id: deploy
name: Deploy
uses: nwtgck/actions-netlify@v2.0.0
uses: nwtgck/actions-netlify@v3.0.0
with:
publish-dir: "${{ inputs.app && format('apps/{0}/', inputs.app) }}pkg/netlify/publish/"
functions-dir: "${{ inputs.app && format('apps/{0}/', inputs.app) }}pkg/netlify/functions/"
Expand Down
6 changes: 3 additions & 3 deletions .github/actions/scan-app/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ runs:
run: |
PRETTY_TARGET="${TARGET#https://}"
echo "write-issue=$([[ \"${GITHUB_REF#refs/heads/}\" != \"${BASELINE_BRANCH}\" ]] && echo 'false' || echo 'true')" >> ${GITHUB_OUTPUT}
echo "fail-action=$([[ \"${GITHUB_REF#refs/heads/}\" != \"${BASELINE_BRANCH}\" ]] && echo 'true' || true)" >> ${GITHUB_OUTPUT}
echo "fail-action=$([[ \"${GITHUB_REF#refs/heads/}\" != \"${BASELINE_BRANCH}\" ]] && echo 'true' || echo 'false')" >> ${GITHUB_OUTPUT}
echo "prefix=${PRETTY_TARGET:-${APP}}" >> ${GITHUB_OUTPUT}
echo "target=${TARGET:-http://localhost:8080}" >> ${GITHUB_OUTPUT}
- name: ZAP Scan (baseline)
if: inputs.smoke
uses: zaproxy/action-baseline@v0.7.0
uses: zaproxy/action-baseline@v0.12.0
with:
token: ${{ inputs.token }}
target: ${{ steps.info.outputs.target }}
Expand All @@ -49,7 +49,7 @@ runs:

- name: ZAP Scan (full)
if: ${{ !inputs.smoke }}
uses: zaproxy/action-full-scan@v0.4.0
uses: zaproxy/action-full-scan@v0.10.0
with:
token: ${{ inputs.token }}
target: ${{ steps.info.outputs.target }}
Expand Down
4 changes: 2 additions & 2 deletions .github/actions/scan-code/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ runs:
steps:

- name: Initialize CodeQL
uses: github/codeql-action/init@v2
uses: github/codeql-action/init@v3
with:
languages: 'javascript'

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
uses: github/codeql-action/analyze@v3
2 changes: 1 addition & 1 deletion .github/actions/scan-dependencies/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ runs:
steps:

- name: Cache vdb
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: |
${{ github.workspace }}/vdb
Expand Down
10 changes: 5 additions & 5 deletions .github/actions/setup/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ runs:
sudo update-locale LANG=${{ env.LANG }}
- name: Setup PNPM
uses: pnpm/action-setup@v2.2.4
uses: pnpm/action-setup@v3.0.0
with:
version: 7.33.6
run_install: false

- name: Setup Node.js
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: ${{ inputs.node }}
cache: 'pnpm'

- name: Cache Cypress.io
uses: actions/cache@v3
uses: actions/cache@v4
env:
cache-hash: ${{ hashFiles('pnpm-lock.yaml') }}
with:
Expand All @@ -40,7 +40,7 @@ runs:

- name: Pull dependencies
if: ${{ !inputs.frozen-lockfile || inputs.frozen-lockfile == 'false' }}
uses: pnpm/action-setup@v2.2.4
uses: pnpm/action-setup@v3.0.0
with:
version: 7.33.6
run_install: |
Expand All @@ -49,7 +49,7 @@ runs:
- name: Pull dependencies (frozen lock-file)
if: ${{ inputs.frozen-lockfile && inputs.frozen-lockfile != 'false' }}
uses: pnpm/action-setup@v2.2.4
uses: pnpm/action-setup@v3.0.0
with:
version: 7.33.6
run_install: true
14 changes: 7 additions & 7 deletions .github/workflows/change-assurance.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
steps:

- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Scan code-base
uses: ./.github/actions/scan-code
Expand All @@ -30,7 +30,7 @@ jobs:
steps:

- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Setup
uses: ./.github/actions/setup
Expand All @@ -50,7 +50,7 @@ jobs:
steps:

- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Setup
uses: ./.github/actions/setup
Expand All @@ -71,7 +71,7 @@ jobs:
steps:

- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Setup
uses: ./.github/actions/setup
Expand All @@ -84,7 +84,7 @@ jobs:
app: ${{ matrix.app }}

- name: Save build directory
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: 'build-${{ matrix.app }}'
path: "${{ matrix.app && format('apps/{0}/', matrix.app) }}dist"
Expand All @@ -103,15 +103,15 @@ jobs:
steps:

- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Setup
uses: ./.github/actions/setup
with:
node: 18

- name: Download build directory
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
name: 'build-${{ matrix.app }}'
path: "${{ matrix.app && format('apps/{0}/', matrix.app) }}dist"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/deploy-to-heroku.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
steps:

- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Setup
uses: ./.github/actions/setup
Expand Down Expand Up @@ -58,7 +58,7 @@ jobs:
steps:

- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Setup
uses: ./.github/actions/setup
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/deploy-to-netlify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
steps:

- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Setup
uses: ./.github/actions/setup
Expand Down Expand Up @@ -64,7 +64,7 @@ jobs:
steps:

- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Setup
uses: ./.github/actions/setup
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
steps:

- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
fetch-depth: 0

Expand All @@ -22,7 +22,7 @@ jobs:
node: 18

- name: Push Storybook to Chromatic
uses: chromaui/action@v1
uses: chromaui/action@v11
with:
token: ${{ secrets.GITHUB_TOKEN }}
projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
steps:

- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
token: ${{ secrets.PAT }}

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/static-security-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
fail-fast: false
steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Scan code-base
uses: ./.github/actions/scan-code
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/update-built-files.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
steps:

- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
token: ${{ secrets.PAT }}

Expand Down Expand Up @@ -41,7 +41,7 @@ jobs:
steps:

- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Scan code-base
uses: ./.github/actions/scan-code
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,6 @@ We publish our documentation site when pushing to the `master` branch.
[components/]: ./components/
[pnpm-workspaces.yaml]: ./pnpm-workspaces.yaml
[plopfile.js]: ./plopfile.js
[install pnpm]: https://pnpm.js.org/en/installation
[install pnpm]: https://pnpm.io/installation
[PLOP]: https://plopjs.com/
[documentation application]: ./apps/docs
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ const Page: FC<PageProps> = ({ location }) => (
<p>Download the posters for your office space and help colleagues think about how to write inclusively.</p>

<h2>Help improve this guidance</h2>
<p>To contribute, send your request to <A href="mailto:design@digital.homeoffice.gov.uk">design@digital.homeoffice.gov.uk,</A> or add it to the <A href="https://github.com/UKHomeOffice/design-system/discussions/557">GitHub discussion</A>.</p>
<p>To contribute, send your request to <A href="mailto:ucdops@homeoffice.gov.uk">ucdops@homeoffice.gov.uk,</A> or add it to the <A href="https://github.com/UKHomeOffice/design-system/discussions/557">GitHub discussion</A>.</p>


</div>
Expand Down
43 changes: 35 additions & 8 deletions apps/docs/src/common/pages/content-style-guide.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,26 @@ import { AZNavigation } from '@hods/components';
export const title = 'Content style guide';
const description = 'How to write content for Home Office services.';

export const menu = (
<Fragment>

<NavigationMenu items={[
{
href: '/accessibility/inclusive-language',
text: 'Inclusive language'
},
{
href: '/accessibility/readability',
text: 'Readability'
},
{
href: '/content-style-guide/designing-for-limited-english',
text: 'Designing for users with limited English'
}
]} />
</Fragment>
);

const Page: FC<PageProps> = ({ location }) => (
<Fragment>
<Helmet>
Expand All @@ -17,20 +37,25 @@ const Page: FC<PageProps> = ({ location }) => (
<meta name="og:article:section" content={title} />
</Helmet>

<h1>{title}</h1>
<AZNavigation id="a-z-nav" />
<div className="govuk-grid-column-one-quarter">
{menu}
</div>

<div className="govuk-grid-row">
<h1>{title}</h1>
<div className="govuk-grid-column-two-thirds">
<AZNavigation id="a-z-nav" />
<h2 className="a-z-header" id="a">A</h2>
<h3 id="abroad">abroad</h3>
<p>'Abroad' and 'overseas' can cause confusion. Try to use plain English. For example, 'apply from outside the UK' or 'working in another country'.</p>
<h3 id="account">account</h3>
<p>Use 'create an account' rather than 'register an account' or set up an account.</p>
<p>Use 'create' instead of 'register' or 'set up' when you want people to create an account. 'Create an account' tested well in user research and is used by other government departments.</p>
<h3 id="acronyms">acronyms</h3>
<p>Write out an acronym in full the first time you use it on a new page or screen, unless it is well known to your users, like UK, US or NHS. Research has found that some users struggle to remember the meaning of an acronym they saw on a previous screen. For example, write 'biometric residence permit (BRP)' on each screen of your service at first mention and use 'BRP' if it appears again on the same screen. If available, use a tooltip like <A href="https://www.gov.uk/guidance/how-to-publish-on-gov-uk/markdown#acronyms">acronym Markdown</A> to make the acronym appear in full as hover text. See more guidance on abbreviations and acronyms in <A href="https://www.gov.uk/guidance/style-guide/a-to-z-of-gov-uk-style">the GOV.UK style guide</A>.</p>
<h3 id="alter">alter</h3>
<p>Use 'change' rather than 'alter', 'modify' or 'switch'.</p>
<h3 id="authorising officer">authorising officer</h3>
<p>Lower case. You can use the acronym 'AO' after the first full mention.</p>
<h3 id="asylum claimant">asylum claimant</h3>
<p>You can use either 'asylum claimant' or 'asylum applicant' to describe someone who has applied for asylum in the UK. Do not use both in the same product or service.</p>
<a className="back-to-top" href="#a-z-nav">Back to top</a>
Expand Down Expand Up @@ -199,7 +224,7 @@ const Page: FC<PageProps> = ({ location }) => (
<h3 id="life in the uk test">Life in the UK Test</h3>
<p>Capitalise the ‘L’ and ‘T’. After first mention, you can refer to ‘the test’, using lower case.</p>
<h3 id="log in">log in</h3>
<p>Use sign in rather than log in’, ‘login’ or ‘logon’.</p>
<p>Use 'sign in' rather than 'log in' or 'login'. Use 'sign in to' rather than 'sign into'.</p>
<a className="back-to-top" href="#a-z-nav">Back to top</a>

<h2 className="a-z-header" id="m">M</h2>
Expand Down Expand Up @@ -259,7 +284,7 @@ const Page: FC<PageProps> = ({ location }) => (
<h3 id="rank">rank (police and armed forces)</h3>
<p>Capitalise the rank before the name, as in 'Detective Inspector Joan Smith'. Use lower case when it follows the name, as in 'Joan Smith, a detective inspector'.</p>
<h3 id="register">register</h3>
<p>Use create an account’ rather than ‘register or set upan account.</p>
<p>Use 'create' instead of 'register' or 'set up' when you want people to create an account. 'Create an account' tested well in user research and is used by other government departments.</p>
<h3 id="right">right</h3>
<p>Use ‘correct’ rather than ‘right’. For example, ‘Select the correct settlement route’.</p>
<a className="back-to-top" href="#a-z-nav">Back to top</a>
Expand All @@ -274,11 +299,13 @@ const Page: FC<PageProps> = ({ location }) => (
<h3 id="settlement">settlement</h3>
<p>'Indefinite leave to remain' and 'indefinite leave to enter' are officially called 'settlement'. For example, 'apply for UK settlement'.</p>
<h3 id="set up">set up</h3>
<p>Use 'create an account' rather than 'register' or 'set up' an account.</p>
<p>Use 'create' instead of 'register' or 'set up' when you want people to create an account. 'Create an account' tested well in user research and is used by other government departments.</p>
<h3 id="sex">sex</h3>
<p>Find out how to ask users for their sex in <A href="https://design.homeoffice.gov.uk/patterns/ask-sex-or-gender">the Home Office sex and gender pattern</A>.</p>
<h3 id="sign in">sign in</h3>
<p>Use 'sign in' rather than 'log in' or 'login'.</p>
<p>Use 'sign in’ rather than 'log in' or 'login'. Use 'sign in to' rather than 'sign into'.</p>
<h3 id="sponsor">sponsor</h3>
<p>Lower case. A company or person sponsoring an individual to work in the UK and supporting their visa application.</p>
<h3 id="sorry">sorry</h3>
<p>Avoid using 'sorry'. See guidance in <A href="https://www.gov.uk/service-manual/design/writing-for-user-interfaces">Writing for user interfaces</A> on GOV.UK.</p>
<h3 id="sovereign base areas">Sovereign Base Areas</h3>
Expand Down Expand Up @@ -329,7 +356,7 @@ const Page: FC<PageProps> = ({ location }) => (
<a className="back-to-top" href="#a-z-nav">Back to top</a>

<h2>Help improve this guide</h2>
<p>To contribute, send your request to <A href="mailto:design@digital.homeoffice.gov.uk">design@digital.homeoffice.gov.uk,</A> or add it to the <A href="https://github.com/UKHomeOffice/design-system/discussions/470">GitHub discussion</A>.</p>
<p>To contribute, send your request to <A href="mailto:ucdops@homeoffice.gov.uk">ucdops@homeoffice.gov.uk,</A> or add it to the <A href="https://github.com/UKHomeOffice/design-system/discussions/470">GitHub discussion</A>.</p>
</div>
</div>
</Fragment>
Expand Down
Loading

0 comments on commit 23305ac

Please sign in to comment.