Skip to content

Commit

Permalink
πŸ™ˆ Add .lycheeignore and update urls
Browse files Browse the repository at this point in the history
Signed-off-by: Richard Baguley <20583399+bagg3rs@users.noreply.github.com>
  • Loading branch information
bagg3rs committed Jun 4, 2024
1 parent abb0c58 commit 1d9686b
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ improves performance, or solves a specific issue. -->
> [!NOTE]
> Each items should be checked. Skipping below checks could delay your PR review!
- [ ] I have reviewed the [style guide](https://technical-documentation.analytical-platform.service.justice.gov.uk/documentation/platform/infrastructure/terraform.html#terraform)
- [ ] I have reviewed the [style guide](https://docs.analytical-platform.service.justice.gov.uk/documentation/platform/infrastructure/terraform.html#terraform)
and ensured that my code complies with it
- [ ] All checks have passed (or override label applied, if I've
used the `override-static-analysis` label, I've explained why)
Expand Down
8 changes: 8 additions & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
https://login.cloud-platform.service.justice.gov.uk
https://github.com/ministryofjustice/data-platform-github-access
https://github.com/ministryofjustice/data-platform-support
https://github.com/ministryofjustice/analytics-platform-auth-proxy
https://github.com/ministryofjustice/data-platform-app-template
https://github.com/ministryofjustice/analytics-platform-rstudio
http://localhost:4567/
file:///home/runner/work/analytical-platform/analytical-platform/docs/source
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ The repositories we manage with terraform see [here](https://github.com/ministry

It may be also useful to look at:

- [Technical documentation](https://technical-documentation.analytical-platform.service.justice.gov.uk/)
- [Architecture Decision Records (ADRs)](https://technical-documentation.analytical-platform.service.justice.gov.uk/documentation/adrs/adr-index.html)
- [Technical documentation](https://docs.analytical-platform.service.justice.gov.uk/)
- [Architecture Decision Records (ADRs)](https://docs.analytical-platform.service.justice.gov.uk/documentation/adrs/adr-index.html)

## Getting in touch

Expand Down Expand Up @@ -96,14 +96,12 @@ As above - preferably our Slack channel: [#ask-analytical-platform](https://moj.

## Editing and publishing the Technical Documentation

The [published](https://technical-documentation.analytical-platform.service.justice.gov.uk/)
The [published](https://docs.analytical-platform.service.justice.gov.uk/)
documentation is created by editing `*.html.md.erb` files,
found in the [docs source](docs/source/) folder.

The syntax is Markdown, more details can be found [here](https://daringfireball.net/projects/markdown/).

For guidance see the Tech Docs Template [Write your content](https://tdt-documentation.london.cloudapps.digital/write_docs/content/).

While editing the files locally, you can start a Docker container that will use
Middleman to act as a server hosting the web pages. See [preview docs](#preview-docs).

Expand Down Expand Up @@ -148,7 +146,7 @@ The web page layout is configured using the config/tech-docs.yml file.
The template can be configured in [config/tech-docs.yml](config/tech-docs.yml)

Further configuration options are described on the Tech Docs Template
website: [Global Configuration](https://tdt-documentation.london.cloudapps.digital/configure_project/global_configuration/).
website: [Global Configuration](https://github.com/alphagov/tdt-documentation/blob/main/config/tech-docs.yml).

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion config/tech-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ phase: Alpha

# Links to show on right-hand-side of header
header_links:
🏠 Home: https://technical-documentation.analytical-platform.service.justice.gov.uk/
🏠 Home: https://docs.analytical-platform.service.justice.gov.uk/
πŸ”§ Our Main GitHub repo: https://github.com/ministryofjustice/analytical-platform
πŸ’¬ Ask Slack Channel: https://mojdt.slack.com/archives/C04VBJTKY58

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ review_in: 6 months

## Context

The Data Platform team will need a way to store secrets securely. There are [several methods](https://security-guidance.service.justice.gov.uk/secrets-management/#application--infrastructure-secrets) currently used across the MoJ, including [Secrets Manager](https://aws.amazon.com/secrets-manager/), [Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html), [1Password](https://operations-engineering.service.justice.gov.uk/documentation/services.html#services), [Git-Crypt](https://github.com/AGWA/git-crypt) and [GitHub Secrets.](https://docs.github.com/en/actions/security-guides/encrypted-secrets)
The Data Platform team will need a way to store secrets securely. There are [several methods](https://security-guidance.service.justice.gov.uk/secrets-management/#application--infrastructure-secrets) currently used across the MoJ, including [Secrets Manager](https://aws.amazon.com/secrets-manager/), [Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html), [1Password](https://user-guide.operations-engineering.service.justice.gov.uk/documentation/services/1password.html), [Git-Crypt](https://github.com/AGWA/git-crypt) and [GitHub Secrets.](https://docs.github.com/en/actions/security-guides/encrypted-secrets)

We want to adhere to [MoJ Security Guidance](https://security-guidance.service.justice.gov.uk/secrets-management/#application--infrastructure-secrets) and align with other [Hosting and Platform teams.](https://technical-guidance.service.justice.gov.uk/documentation/standards/hosting.html)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The following locations will be used for documenting all things related to the D

### Team and Technical

>Team information, ways of working and ADRs should be stored in the open in our technical documentation [here](https://technical-documentation.analytical-platform.service.justice.gov.uk/)
>Team information, ways of working and ADRs should be stored in the open in our technical documentation [here](https://docs.analytical-platform.service.justice.gov.uk/)
>Documentation directly relating to code should be stored in a `README.MD` next to the code in its repository

### Sensitive information
Expand Down

0 comments on commit 1d9686b

Please sign in to comment.