Skip to content

Commit 465af47

Browse files
Accessibility - Are all links clear and descriptive (WCAG 2.4.4) (#235)
Yup, they're all clear. Descriptive is subjective, but they'll do.
1 parent 002f1cb commit 465af47

File tree

10 files changed

+19
-15
lines changed

10 files changed

+19
-15
lines changed

source/FurtherDetails/glossary.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ SciTech Review:
7373

7474
Simulation Systems and Deployment Team:
7575
The team responsible for the oversight of these working practices. For
76-
more information see here :ref:`ssd`
76+
more information see :ref:`ssd`.
7777

7878
Simulation Systems Governance Group:
7979
The governing body that oversees the work of the Simulation Systems and

source/FurtherDetails/who.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Sci/Tech Reviewer
7171

7272
A Sci/Tech reviewer is assigned for every ticket and comprises the first stage
7373
of review that considers the change as a whole. Further details are linked from
74-
the Working Practices :ref:`here <scitech>`. In some cases, the reviewer can
74+
the :ref:`Working Practices page<scitech>`. In some cases, the reviewer can
7575
delegate parts of the work to another person.
7676

7777
Reviews should be turned around on a reasonable timescale and follow the SciTech
@@ -87,7 +87,7 @@ Code Reviewer
8787
-------------
8888

8989
The Code Reviewer performs the 2nd stage of review for every ticket.
90-
Further details are described :ref:`here <codereview>`.
90+
Further details are described :ref:`Working Practices page<codereview>`.
9191

9292
Reviews should be turned around on a reasonable timescale and follow the Code
9393
Review guidance.

source/Reviewers/committinglinkedtickets.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ Testing linked tickets
4444
With the branches from all the tickets merged into a working copy of their
4545
respective Head of Trunk these can all be used together to test the change.
4646

47-
Details for testing multi-repository tickets are included :ref:`here <multirepo>`.
47+
Details for testing multi-repository tickets are included on the
48+
:ref:`Working with Multiple Repositories page<multirepo>`.
4849

4950
**In summary:**
5051

source/Reviewers/howtocommit.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,8 @@ even trivial tickets to check that the merge has not caused issues, or that ther
212212
are no clashes with what else has gone on trunk.
213213

214214
.. note::
215-
Linked tickets will need to be tested together as discussed :ref:`here <tesinglinked>`.
215+
Linked tickets will need to be tested together as discussed
216+
on the :ref:`Committing Linked Tickets page<tesinglinked>`.
216217

217218
.. tab-set::
218219

source/WorkingPractices/TestSuites/lfric_core.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,5 @@ It is also possible to select the platform to run on. Available options include
3838
.. tip::
3939

4040
For more details on LFRic testing including details of unit tests please
41-
visit the trac wiki
42-
`here <https://code.metoffice.gov.uk/trac/lfric/wiki/LFRicTechnical/Testing>`_.
41+
visit the `LFRic testing trac wiki page <https://code.metoffice.gov.uk/trac/lfric/wiki/LFRicTechnical/Testing>`_.
4342

source/WorkingPractices/TestSuites/multi-repo_testing.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Multi-repository changes are expected to pass the regression tests for all the
77
repositories involved. To carry out the tests involved in a linked ticket it can
88
be helpful to refer to the :ref:`semi-concentric circles figure <multirepo>`; layering the testing
99
from the inside out as needed. Further details of how testing in each
10-
repository is handled can be found :ref:`here <testing>`. Compatible
10+
repository is handled can be found on the :ref:`Testing page<testing>`. Compatible
1111
code revisions are needed for testing across repositories as described above.
1212

1313
Testing changes in JULES, LFRic Core, UKCA, or any other child repositories is
@@ -89,7 +89,8 @@ these paths can either be to local changes or those in the repository.
8989
cylc play <working copy name>
9090
cylc gui
9191
92-
More details on LFRic Apps testing are found :ref:`here<lfric_apps_test>`.
92+
More details on LFRic Apps testing are found on the
93+
:ref:`Testing LFRic Apps page<lfric_apps_test>`.
9394

9495
.. note::
9596
If any of the testing shows up failures then there are two possible ways to

source/WorkingPractices/TestSuites/ukca.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ Changes in UKCA that touch `src/science` or `src/control/core` must be tested
55
with both the UM and LFRic by following the :ref:`linked tickets guidance <multirepo>`.
66

77
For further guidance on testing and working with UKCA, including standard
8-
suites and box models see
9-
`here <https://code.metoffice.gov.uk/trac/ukca/wiki/WorkingPractices>`_
8+
suites and box models see the
9+
`UKCA trac wiki<https://code.metoffice.gov.uk/trac/ukca/wiki/WorkingPractices>`_.

source/WorkingPractices/documentation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Most notably:
1515

1616
LFRic Apps and Core also use doxygen to document the code and all changes should
1717
include appropriate doxygen changes to go with them. Doxygen guidelines are
18-
available `here <https://code.metoffice.gov.uk/trac/lfric/wiki/LFRicTechnical/DoxygenUsage>`_.
18+
available on the `LFRic Technical pages<https://code.metoffice.gov.uk/trac/lfric/wiki/LFRicTechnical/DoxygenUsage>`_.
1919

2020
.. toctree::
2121
:hidden:

source/WorkingPractices/kgo.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ such changes onto the trunk. When preparing your change for review:
8282

8383
.. tip::
8484
More details on the KGO update proceedures for all repositories can be found
85-
:ref:`here <kgo_instructions>`.
85+
on the :ref:`How to Commit page<kgo_instructions>`.
8686

8787
.. toctree::
8888
:hidden:

source/WorkingPractices/reviews.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,8 @@ fill in a :ref:`SciTech Review Checklist <template>` which makes sure all
9696
aspects of the ticket are considered. Once the reviewer is satisfied, they will
9797
pass the ticket on to code/system review.
9898

99-
Guidance for the SciTech reviewer can be found :ref:`here <scitech_review>`.
99+
Guidance for the SciTech reviewer can be found on the
100+
:ref:`SciTech review page <scitech_review>`.
100101

101102
.. _codereview:
102103

@@ -119,7 +120,8 @@ will be needed in this case.
119120
Once the code reviewer is satisfied they will move the ticket into the `approved`
120121
state, ready for commit to the trunk.
121122

122-
Guidance for the code reviewer can be found :ref:`here <code_review>`.
123+
Guidance for the code reviewer can be found on the
124+
:ref:`Code Review page <code_review>`.
123125

124126
-----
125127

0 commit comments

Comments
 (0)