Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Tech-docs-name-change #4410

Merged
merged 29 commits into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
9db3f51
Update data-platform to analytical-platform
bagg3rs May 23, 2024
d381c4d
Update owner_slack to #analytical-platform-notifications in ADR and d…
bagg3rs May 23, 2024
b643135
Update owner_slack to #analytical-platform-notifications in ADR and d…
bagg3rs May 24, 2024
55aa28f
Update owner_slack to #analytical-platform-notifications in ADR and d…
bagg3rs May 27, 2024
c8345e5
Change hostname back to not break DNS
bagg3rs May 27, 2024
8e63e62
First update of C4 diagrams
bagg3rs May 27, 2024
6c14d0d
🚨 Linting
Gary-H9 May 28, 2024
12ab0e9
🚨 Linting
Gary-H9 May 28, 2024
bc76e1b
Update SEARCH_QUERY in issue-metrics.yml to use analytical-platform r…
bagg3rs Jun 4, 2024
6304128
🔥 Remove testing section in README for `daap-get-glue-metadata`
bagg3rs Jun 4, 2024
c598a7e
🔥 Remove `OpenSSF Best Practices` from README
bagg3rs Jun 4, 2024
3b5d43e
🔥 Remove last review date from README, as we have github versioning
bagg3rs Jun 4, 2024
fef6127
🔥 Remove unused products repository from README
bagg3rs Jun 4, 2024
7b6f3cf
🍱 Add repositories that we manage and remove archived
bagg3rs Jun 4, 2024
dce8e0e
fire
bagg3rs Jun 4, 2024
3955602
📑 Fix headings for publishing
bagg3rs Jun 4, 2024
c76665d
📑 promote hosting
bagg3rs Jun 4, 2024
f559efc
🔗 Update ask channel and add url
bagg3rs Jun 4, 2024
6c8ecb2
📝 Update README to provide clearer description of the Analytical Plat…
bagg3rs Jun 4, 2024
1dc0844
📝 Format intro and move contributing
bagg3rs Jun 4, 2024
0bf7729
✨ add Cloud Platform App template
bagg3rs Jun 4, 2024
6e78499
Update tdt
Jun 4, 2024
abb0c58
chore: disable CSS validation in super linter workflow
Jun 4, 2024
1d9686b
🙈 Add .lycheeignore and update urls
bagg3rs Jun 4, 2024
cd64409
📝 remove example url
bagg3rs Jun 4, 2024
45c64fc
🚨 Update md linter line_length
bagg3rs Jun 4, 2024
88d3361
Add MD013 rule
bagg3rs Jun 4, 2024
0f3cc36
Merge branch 'main' into tech-docs-name-change
bagg3rs Jun 4, 2024
9d3804a
🚨 Add URL to ignore 🙈
bagg3rs Jun 4, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .devcontainer/devcontainer-lock.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
{
"features": {
"ghcr.io/devcontainers/features/docker-in-docker:2": {
"version": "2.11.0",
"resolved": "ghcr.io/devcontainers/features/docker-in-docker@sha256:503f23cd692325b3cbb8c20a0ecfabb3444b0c786b363e0c82572bd7d71dc099",
"integrity": "sha256:503f23cd692325b3cbb8c20a0ecfabb3444b0c786b363e0c82572bd7d71dc099"
},
"ghcr.io/devcontainers/features/github-cli:1": {
"version": "1.0.11",
"resolved": "ghcr.io/devcontainers/features/github-cli@sha256:464564228ccdd6028f01f8a62a3cfbaf76e9ba7953b29ac0e53ba2c262604312",
Expand Down
8 changes: 7 additions & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"name": "analytical-platform",
"image": "ghcr.io/ministryofjustice/devcontainer-base:latest",
"features": {
"ghcr.io/devcontainers/features/docker-in-docker:2": {},
"ghcr.io/devcontainers/features/github-cli:1": {},
"ghcr.io/ministryofjustice/devcontainer-feature/aws:1": {},
"ghcr.io/ministryofjustice/devcontainer-feature/kubernetes:1": {},
Expand All @@ -15,7 +16,12 @@
"EditorConfig.EditorConfig",
"GitHub.vscode-github-actions",
"GitHub.vscode-pull-request-github"
]
],
"settings": {
"files.associations": {
"*.html.md.erb": "markdown"
}
}
}
}
}
2 changes: 2 additions & 0 deletions .github/linters/.markdown-lint.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
---
MD024:
siblings_only: true
MD013:
line_length: 180
19 changes: 13 additions & 6 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
### Pull Request Objective
# Pull Request Objective

This piece of work is being tracked in [this](https://github.com/ministryofjustice/data-platform/issues/<your_issue_number_here>) GitHub Issue.
This piece of work is being tracked in
[this](https://github.com/ministryofjustice/analytical-platform/issues/<your_issue_number_here>)
GitHub Issue.

<!-- Please describe the purpose of this pull request. Detail the problem it addresses or the functionality it adds. Highlight how this contributes to the project goals, improves performance, or solves a specific issue. -->
<!-- Please describe the purpose of this pull request.
Detail the problem it addresses or the functionality it adds.
Highlight how this contributes to the project goals,
improves performance, or solves a specific issue. -->

### Checklist
## Checklist

> [!NOTE]
> Each items should be checked. Skipping below checks could delay your PR review!

- [ ] I have reviewed the [style guide](https://technical-documentation.data-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)
- [ ] 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)
- [ ] I have self-reviewed my code
- [ ] I have reviewed the checks and can attest they're as expected

Expand Down
60 changes: 60 additions & 0 deletions .github/workflows/build-publish-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
name: Build and Publish Documentation

on:
push:
branches:
- main

permissions: {}

concurrency:
group: github-pages
cancel-in-progress: true

jobs:
build:
name: Build
runs-on: ubuntu-latest
container:
image: docker.io/ministryofjustice/tech-docs-github-pages-publisher@sha256:cd3513beca3fcaf5dd34cbe81a33b3ff30337d8ada5869b40a6454c21d6f7684 # v4.0.0
permissions:
contents: read
steps:
- name: Checkout
id: checkout
uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6

- name: Build
id: build
run: |
/usr/local/bin/package

- name: Upload Artifact
id: upload_artifact
uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
with:
name: github-pages
path: artifact.tar
retention-days: 1
overwrite: true

publish:
needs: build
name: Publish
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.configure_pages.outputs.base_url }}
permissions:
contents: read
id-token: write
pages: write
steps:
- name: Configure Pages
id: configure_pages
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0

- name: Deploy to GitHub Pages
id: deploy_pages
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
44 changes: 44 additions & 0 deletions .github/workflows/build-test-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: Build and Test Documentation

on:
pull_request:
branches:
- main

permissions: {}

jobs:
build:
name: Build
runs-on: ubuntu-latest
container:
image: docker.io/ministryofjustice/tech-docs-github-pages-publisher@sha256:cd3513beca3fcaf5dd34cbe81a33b3ff30337d8ada5869b40a6454c21d6f7684 # v4.0.0
permissions:
contents: read
steps:
- name: Checkout
id: checkout
uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6

- name: Build
id: build
run: |
/usr/local/bin/package

test:
name: Test
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout
id: checkout
uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6

- name: Lychee
id: lychee
uses: lycheeverse/lychee-action@2b973e86fc7b1f6b36a93795fe2c9c6ae1118621 # v1.10.0
with:
args: --verbose --no-progress './**/*.md' './**/*.html' './**/*.erb' --accept 403,200,429
fail: true
73 changes: 0 additions & 73 deletions .github/workflows/documentation.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/issue-metrics.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
uses: github/issue-metrics@0926cffe61d20f924b1d9e3f04224da393f35a95 # v3.7.0
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SEARCH_QUERY: 'repo:ministryofjustice/data-platform is:issue created:${{ env.last_month }} -reason:"not planned"'
SEARCH_QUERY: 'repo:ministryofjustice/analytical-platform is:issue created:${{ env.last_month }} -reason:"not planned"'

- name: Create issue
id: create_issue
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/repository-super-linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,4 @@ jobs:
VALIDATE_TERRAFORM_TERRASCAN: false
VALIDATE_CHECKOV: false
VALIDATE_JSCPD: false
VALIDATE_CSS: false
9 changes: 9 additions & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
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
https://design-system.service.gov.uk/components/
28 changes: 15 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
<!-- markdownlint-disable MD013 -->
# Contributing to the MoJ Data Platform
# Contributing to the MoJ Analytical platform

## Table of contents

* [Code of Conduct](#code-of-conduct)
* [Standards](#standards)
* [Reporting Bugs](#reporting-bugs)
* [Reporting security issues](#reporting-security-issues)
* [Signing Contributions](#signing-contributions)
* [External Contributions](#external-contributions)
* [Licence](#licence)
- [Contributing to the MoJ Analytical platform](#contributing-to-the-moj-analytical-platform)
- [Table of contents](#table-of-contents)
- [Code of Conduct](#code-of-conduct)
- [Standards](#standards)
- [Reporting bugs](#reporting-bugs)
- [Reporting security issues](#reporting-security-issues)
- [Signing contributions](#signing-contributions)
- [External contributions](#external-contributions)
- [Licence](#licence)

## Code of Conduct

Expand All @@ -24,7 +26,7 @@ and also the MoJ [Cyber and Technical Security Guidance](https://security-guidan

## Reporting bugs

Bugs are tracked on the [project issues](https://github.com/ministryofjustice/data-platform/issues) page. Please check if your issue has already been filed by someone else by searching the existing issues before filing a new one. Once your issue is filed, it will be triaged by another contributor or maintainer.
Bugs are tracked on the [project issues](https://github.com/ministryofjustice/analytical-platform/issues) page. Please check if your issue has already been filed by someone else by searching the existing issues before filing a new one. Once your issue is filed, it will be triaged by another contributor or maintainer.

## Reporting security issues

Expand All @@ -33,7 +35,7 @@ Please report any security issues inline with the Ministry of Justice [Vulnerabi
## Signing contributions

In addition to following the above guidance,
the data platform also requires that all git commits are signed.
the analytical platform also requires that all git commits are signed.
This will enable the project to improve project integrity,
begin to secure the supply chain,
and [provide assurances about security practices](https://slsa.dev/).
Expand All @@ -43,11 +45,11 @@ as they are very good.

## External contributions

The Data Platform is developed [in the open](https://gds.blog.gov.uk/2014/07/22/making-things-open-making-things-better/),
The Analytical platform is developed [in the open](https://gds.blog.gov.uk/2014/07/22/making-things-open-making-things-better/),
but this is done primarily by Ministry of Justice staff.
Although it's possible that external contributions may be accepted,
please discuss your change [in an issue](/ministryofjustice/data-platform/issues) before submitting a pull request.
please discuss your change [in an issue](/ministryofjustice/analytical-platform/issues) before submitting a pull request.

## Licence

The software and assets within this repository are licensed under the [MIT Licence](https://github.com/ministryofjustice/data-platform/blob/main/LICENSE).
The software and assets within this repository are licensed under the [MIT Licence](https://github.com/ministryofjustice/analytical-platform/blob/main/LICENSE).
Loading