Skip to content

Commit

Permalink
Reviewing and updating review dates for HMCTS Way pages from daily ch…
Browse files Browse the repository at this point in the history
…ecks (#492)

* Reviewing and updating review dates for HMCTS Way pages from daily checks

* Update broken link
  • Loading branch information
MartyFox authored Sep 23, 2024
1 parent 1dd8c9d commit 82c2455
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 12 deletions.
6 changes: 3 additions & 3 deletions source/cloud-native-platform/api-docs/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: API Documentation
last_reviewed_on: 2023-08-16
last_reviewed_on: 2023-09-20
review_in: 12 months
weight: 100
---

# API Documentation
# <%= current_page.data.title %>

All teams building APIs should be automatically publishing their documentation using the
[OpenAPI Specification 3.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md).
Teams should use [these instructions](https://github.com/hmcts/cnp-api-docs#publish-swagger-docs)
for publishing the swagger spec file to the [central api docs repository](https://github.com/hmcts/cnp-api-docs).

It's expected that all APIs follow our [API standards](/cloud-native-platform/standards/apis.html#api-design).
It's expected that all APIs follow our [API standards](/cloud-native-platform/standards/apis.html).

A network map of microservice dependencies can be generated using this central repository by manually
committing some additional information about the new service.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Automated dependency updates
last_reviewed_on: 2024-05-16
last_reviewed_on: 2024-09-20
review_in: 3 months
weight: 10
hide_in_navigation: true
Expand Down Expand Up @@ -127,7 +127,7 @@ We do not recommend using dependabot.

It is nowhere near as powerful as renovate.

Features missing:
Features missing:

- Centralised configuration
- Flexible scheduling
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Slack
last_reviewed_on: 2024-02-19
last_reviewed_on: 2024-09-20
review_in: 6 months
weight: 1
hide_in_navigation: true
Expand All @@ -15,7 +15,10 @@ Most teams use the [hmcts-reform.slack.com](https://hmcts-reform.slack.com/) wor
After you've created your account please make sure to fill out your profile,
set at least your full name, and in the what I do section put your team name and role.

Now that you've got a slack account you'll need to create a couple of channels:
## New team setup

When creating a new team its important to also create the relevant Slack channels.
The following channels should be created for every team:

- a team contact channel, this must be public as this is where people on other teams will come to contact you,
this is often your regular developer chat channel, i.e. `team-dev` or `team-tech`.
Expand All @@ -29,7 +32,6 @@ Once you've created a build notices channel you will need to invite our 'Jenkins

Make sure you pick the Jenkins \[app] user:


<img src="/images/slack-jenkins-user-invite.png"/>

## Troubleshooting
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Path to live
last_reviewed_on: 2024-01-25
last_reviewed_on: 2024-09-20
review_in: 8 months
weight: 5
---
Expand Down
4 changes: 2 additions & 2 deletions source/cloud-native-platform/standards/apis.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: API design
last_reviewed_on: 2023-08-16
last_reviewed_on: 2023-09-20
review_in: 12 months
weight: 2
hide_in_navigation: true
---

# <%= current_page.data.title %>

Rather than reinvent the wheel, we've decided to reuse and amend the good work done by zalando.
Rather than reinvent the wheel, we've decided to reuse and amend the good work done by Zalando.
Our fork of their standards can be found in the [HMCTS GitHub](https://github.com/hmcts/restful-api-standards/blob/master/README.adoc)
and is published at [hmcts.github.io/restful-api-standards/](https://hmcts.github.io/restful-api-standards/).
2 changes: 1 addition & 1 deletion source/standards/standards/angular.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,6 @@ Bibliography
- [Best Practices in Angular](https://itnext.io/best-practices-in-angular-a8926fa02ae2)
- Clean Code Checklist in Angular
- [Don't follow RxJS Best Practices](https://dev.to/nikpoltoratsky/don-t-follow-rxjs-best-practices-4893)
- [RxJS in Angular: When To Subscribe?](https://indepth.dev/posts/1279/rxjs-in-angular-when-to-subscribe-rarely)
- [RxJS in Angular: When To Subscribe?](https://medium.com/angular-in-depth/when-to-subscribe-a83332ae053)
- [5 Things that Improve your Angular Codebase Right Now](https://malcoded.com/posts/improve-your-angular-codebase/)
- [6 most common mistakes of Angular devs revealed on code reviews](https://alex-klaus.com/angular-code-review/)

0 comments on commit 82c2455

Please sign in to comment.