From bae8ca1afe98f639b4ce4c4d9f2656cb9e2343af Mon Sep 17 00:00:00 2001 From: Marty Fox Date: Mon, 23 Sep 2024 13:13:39 +0100 Subject: [PATCH 1/3] Reviewing and updating review dates for HMCTS Way pages from daily checks --- source/cloud-native-platform/api-docs/index.html.md.erb | 6 +++--- .../guides/automated-dependency-updates.html.md.erb | 4 ++-- .../onboarding/team/slack.html.md.erb | 8 +++++--- .../cloud-native-platform/path-to-live/index.html.md.erb | 2 +- source/cloud-native-platform/standards/apis.html.md.erb | 4 ++-- 5 files changed, 13 insertions(+), 11 deletions(-) diff --git a/source/cloud-native-platform/api-docs/index.html.md.erb b/source/cloud-native-platform/api-docs/index.html.md.erb index c7262c10..c8f5c2c4 100644 --- a/source/cloud-native-platform/api-docs/index.html.md.erb +++ b/source/cloud-native-platform/api-docs/index.html.md.erb @@ -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. diff --git a/source/cloud-native-platform/guides/automated-dependency-updates.html.md.erb b/source/cloud-native-platform/guides/automated-dependency-updates.html.md.erb index 50a857f8..f71f5a38 100644 --- a/source/cloud-native-platform/guides/automated-dependency-updates.html.md.erb +++ b/source/cloud-native-platform/guides/automated-dependency-updates.html.md.erb @@ -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 @@ -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 diff --git a/source/cloud-native-platform/onboarding/team/slack.html.md.erb b/source/cloud-native-platform/onboarding/team/slack.html.md.erb index 5d5a5d2c..80dd251a 100644 --- a/source/cloud-native-platform/onboarding/team/slack.html.md.erb +++ b/source/cloud-native-platform/onboarding/team/slack.html.md.erb @@ -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 @@ -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`. @@ -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: - ## Troubleshooting diff --git a/source/cloud-native-platform/path-to-live/index.html.md.erb b/source/cloud-native-platform/path-to-live/index.html.md.erb index 3eacd286..72935bf9 100644 --- a/source/cloud-native-platform/path-to-live/index.html.md.erb +++ b/source/cloud-native-platform/path-to-live/index.html.md.erb @@ -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 --- diff --git a/source/cloud-native-platform/standards/apis.html.md.erb b/source/cloud-native-platform/standards/apis.html.md.erb index 1e9dac56..5a5d035d 100644 --- a/source/cloud-native-platform/standards/apis.html.md.erb +++ b/source/cloud-native-platform/standards/apis.html.md.erb @@ -1,6 +1,6 @@ --- 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 @@ -8,6 +8,6 @@ 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/). From 22cea7836eb698ea278da65f3d154cc24b66d6ef Mon Sep 17 00:00:00 2001 From: Marty Fox Date: Mon, 23 Sep 2024 14:02:41 +0100 Subject: [PATCH 2/3] Update broken link --- source/standards/standards/angular.html.md.erb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/standards/standards/angular.html.md.erb b/source/standards/standards/angular.html.md.erb index aa119af0..a83db25a 100644 --- a/source/standards/standards/angular.html.md.erb +++ b/source/standards/standards/angular.html.md.erb @@ -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/) From 7aff87d0f45a3c9e9c6e51ef1df76cf24c2bce27 Mon Sep 17 00:00:00 2001 From: Marty Fox Date: Wed, 9 Oct 2024 15:53:51 +0100 Subject: [PATCH 3/3] reviewing and updating pages based on daily checks --- source/cloud-native-platform/api-docs/index.html.md.erb | 4 ---- .../cloud-native-platform/path-to-live/front-door.html.md.erb | 2 +- .../path-to-live/load-balancer-configuration.html.md.erb | 2 +- .../path-to-live/tls-certificates.html.md.erb | 4 ++-- source/cloud-native-platform/standards/apis.html.md.erb | 4 ---- source/cloud-native-platform/standards/index.html.md.erb | 2 +- .../cloud-native-platform/standards/pull-requests.html.md.erb | 2 +- 7 files changed, 6 insertions(+), 14 deletions(-) diff --git a/source/cloud-native-platform/api-docs/index.html.md.erb b/source/cloud-native-platform/api-docs/index.html.md.erb index 89823049..e04cdf58 100644 --- a/source/cloud-native-platform/api-docs/index.html.md.erb +++ b/source/cloud-native-platform/api-docs/index.html.md.erb @@ -1,10 +1,6 @@ --- title: API Documentation -<<<<<<< HEAD -last_reviewed_on: 2023-09-20 -======= last_reviewed_on: 2024-09-24 ->>>>>>> main review_in: 12 months weight: 100 --- diff --git a/source/cloud-native-platform/path-to-live/front-door.html.md.erb b/source/cloud-native-platform/path-to-live/front-door.html.md.erb index f4275dcd..0bc9ecd1 100644 --- a/source/cloud-native-platform/path-to-live/front-door.html.md.erb +++ b/source/cloud-native-platform/path-to-live/front-door.html.md.erb @@ -1,6 +1,6 @@ --- title: Front Door configuration -last_reviewed_on: 2024-04-22 +last_reviewed_on: 2024-10-10 review_in: 6 months weight: 4 --- diff --git a/source/cloud-native-platform/path-to-live/load-balancer-configuration.html.md.erb b/source/cloud-native-platform/path-to-live/load-balancer-configuration.html.md.erb index 53e3ef01..b53c4488 100644 --- a/source/cloud-native-platform/path-to-live/load-balancer-configuration.html.md.erb +++ b/source/cloud-native-platform/path-to-live/load-balancer-configuration.html.md.erb @@ -1,6 +1,6 @@ --- title: Load balancer configuration -last_reviewed_on: 2024-04-22 +last_reviewed_on: 2024-10-10 review_in: 6 months weight: 1 --- diff --git a/source/cloud-native-platform/path-to-live/tls-certificates.html.md.erb b/source/cloud-native-platform/path-to-live/tls-certificates.html.md.erb index e0816c29..ffc7afa5 100644 --- a/source/cloud-native-platform/path-to-live/tls-certificates.html.md.erb +++ b/source/cloud-native-platform/path-to-live/tls-certificates.html.md.erb @@ -1,6 +1,6 @@ --- title: TLS certificates -last_reviewed_on: 2024-04-22 +last_reviewed_on: 2024-10-10 review_in: 6 months weight: 2 --- @@ -44,7 +44,7 @@ We are using [Key Vault Acmebot](https://github.com/shibayan/keyvault-acmebot) f Key Vault Acmebot is deployed from this repository [azure-enterprise-acme](https://github.com/hmcts/azure-enterprise-acme/tree/main) via this [azure-devops pipeline](https://dev.azure.com/hmcts/PlatformOperations/_build?definitionId=656&_a=summary), there is one instance per subscription. -The naming convention for keyvaults and function App are acme`, `sharedservices` is replaced with `sds` because of length limits. e.g. `acmedtssdstest`. The naming convention for certificate name in Key Vault is `-` separated by hyphen. E.g. `hmi-apim-test-platform-hmcts-net`, `wildcard-test-platform-hmcts-net`. diff --git a/source/cloud-native-platform/standards/apis.html.md.erb b/source/cloud-native-platform/standards/apis.html.md.erb index ebd28ef7..386315cc 100644 --- a/source/cloud-native-platform/standards/apis.html.md.erb +++ b/source/cloud-native-platform/standards/apis.html.md.erb @@ -1,10 +1,6 @@ --- title: API design -<<<<<<< HEAD -last_reviewed_on: 2023-09-20 -======= last_reviewed_on: 2024-09-24 ->>>>>>> main review_in: 12 months weight: 2 hide_in_navigation: true diff --git a/source/cloud-native-platform/standards/index.html.md.erb b/source/cloud-native-platform/standards/index.html.md.erb index 12ec4de1..93e0b356 100644 --- a/source/cloud-native-platform/standards/index.html.md.erb +++ b/source/cloud-native-platform/standards/index.html.md.erb @@ -1,6 +1,6 @@ --- title: Concepts and standards -last_reviewed_on: 2024-04-22 +last_reviewed_on: 2024-10-10 review_in: 6 months weight: 2 --- diff --git a/source/cloud-native-platform/standards/pull-requests.html.md.erb b/source/cloud-native-platform/standards/pull-requests.html.md.erb index 6e4f9514..fdcd0b7b 100644 --- a/source/cloud-native-platform/standards/pull-requests.html.md.erb +++ b/source/cloud-native-platform/standards/pull-requests.html.md.erb @@ -1,6 +1,6 @@ --- title: Pull requests -last_reviewed_on: 2024-04-22 +last_reviewed_on: 2024-10-10 review_in: 6 months weight: 1 hide_in_navigation: true