diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..9919259 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,37 @@ +# Description + + + + +## Review checks + + + +### Metadata + +#### Frontmatter +- [ ] `` component at top of document +- [ ] `docType` + - `journey` - A page of curated suggested documents for a persona or purpose + - `explanation` per [Diataxis] + - `tutorial` per [Diataxis] + - `guide` per [Diataxis] + - `reference` per [Diataxis] + - Category or splash pages do not require this +- [ ] `readingTime` in [ISO 8601 Duration] format + - Only required for `explanation`, `tutorial` and `guide` +- [ ] `audiences` - one or more target audiences for the content + - `federation-operator` + - `tre-operator` + - `researcher` + - `integrator` + - `contributor` + - `everyone` + +#### Content + +- [ ] Prerequisites, if appropriate +- [ ] Next steps, if appropriate + +[diataxis]: https://diataxis.fr/ +[ISO 8601 Duration]: https://en.wikipedia.org/wiki/ISO_8601#Durations \ No newline at end of file diff --git a/app/_meta.js b/app/_meta.js index 3828228..5a9170e 100644 --- a/app/_meta.js +++ b/app/_meta.js @@ -1,9 +1,17 @@ export default { - connect: "Connect", - "co-ordinate": "Co-ordinate", + index: { + display: "hidden" + }, // Welcome Report URL redirect, never show in nav five_safes_tes: { display: "hidden" - } + }, + + // exclude routes until content published + "journeys": { + display: "hidden" + }, + + // TODO: restructure content and move "connect" journey page }; diff --git a/app/co-ordinate/_meta.js b/app/co-ordinate/_meta.js deleted file mode 100644 index 551c195..0000000 --- a/app/co-ordinate/_meta.js +++ /dev/null @@ -1,4 +0,0 @@ -export default { - setup_sub_layer: "Setup Submission Layer", - management: "Management", -}; diff --git a/app/co-ordinate/management/page.mdx b/app/co-ordinate/management/page.mdx deleted file mode 100644 index e69de29..0000000 diff --git a/app/co-ordinate/page.mdx b/app/co-ordinate/page.mdx deleted file mode 100644 index 9422c20..0000000 --- a/app/co-ordinate/page.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Co-ordinate -asIndexPage: true ---- - -# Co-ordinate diff --git a/app/co-ordinate/setup_sub_layer/page.mdx b/app/co-ordinate/setup_sub_layer/page.mdx deleted file mode 100644 index e69de29..0000000 diff --git a/app/connect/approvals/page.mdx b/app/connect/approvals/page.mdx index 3416db7..b1a41e8 100644 --- a/app/connect/approvals/page.mdx +++ b/app/connect/approvals/page.mdx @@ -1,4 +1,5 @@ --- +docType: guide readingTime: PT10M audiences: tre-operator --- diff --git a/app/connect/approve-outputs/page.mdx b/app/connect/approve-outputs/page.mdx index c0d5714..4481cd9 100644 --- a/app/connect/approve-outputs/page.mdx +++ b/app/connect/approve-outputs/page.mdx @@ -1,4 +1,5 @@ --- +docType: guide readingTime: PT5M audiences: tre-operator --- diff --git a/app/connect/connect-submission/page.mdx b/app/connect/connect-submission/page.mdx index 4cad953..029e0ed 100644 --- a/app/connect/connect-submission/page.mdx +++ b/app/connect/connect-submission/page.mdx @@ -1,4 +1,5 @@ --- +docType: guide readingTime: PT15M audiences: tre-operator --- diff --git a/app/connect/page.mdx b/app/connect/page.mdx index b014c94..61532f4 100644 --- a/app/connect/page.mdx +++ b/app/connect/page.mdx @@ -1,6 +1,11 @@ --- +docType: journey title: Connect asIndexPage: true --- # Connect + +import {UnderConstruction} from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/connect/setup-tre/configuration/page.mdx b/app/connect/setup-tre/configuration/page.mdx index 57d480a..b4bc052 100644 --- a/app/connect/setup-tre/configuration/page.mdx +++ b/app/connect/setup-tre/configuration/page.mdx @@ -1,4 +1,5 @@ --- +docType: reference readingTime: PT30M audiences: tre-operator --- diff --git a/app/connect/setup-tre/deployment-steps/page.mdx b/app/connect/setup-tre/deployment-steps/page.mdx index 6b41c2f..ad5eab1 100644 --- a/app/connect/setup-tre/deployment-steps/page.mdx +++ b/app/connect/setup-tre/deployment-steps/page.mdx @@ -1,4 +1,5 @@ --- +docType: guide readingTime: PT45M audiences: tre-operator --- diff --git a/app/connect/setup-tre/page.mdx b/app/connect/setup-tre/page.mdx index 03f59e6..b78b340 100644 --- a/app/connect/setup-tre/page.mdx +++ b/app/connect/setup-tre/page.mdx @@ -1,6 +1,11 @@ --- +docType: journey title: Setup TRE Agent asIndexPage: true --- # Setup TRE Agent Journeys + +import {UnderConstruction} from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/connect/tes-backend/install-funnel/page.mdx b/app/connect/tes-backend/install-funnel/page.mdx index ed0fbe6..e105d5f 100644 --- a/app/connect/tes-backend/install-funnel/page.mdx +++ b/app/connect/tes-backend/install-funnel/page.mdx @@ -1,4 +1,5 @@ --- +docType: guide readingTime: PT45M audiences: tre-operator --- diff --git a/app/connect/tes-backend/tes-implementations/page.mdx b/app/connect/tes-backend/tes-implementations/page.mdx index 373b698..a788272 100644 --- a/app/connect/tes-backend/tes-implementations/page.mdx +++ b/app/connect/tes-backend/tes-implementations/page.mdx @@ -1,4 +1,5 @@ --- +docType: explanation readingTime: PT20M audiences: tre-operator --- diff --git a/app/journeys/co-ordinate/_meta.js b/app/journeys/co-ordinate/_meta.js new file mode 100644 index 0000000..3bbdbfd --- /dev/null +++ b/app/journeys/co-ordinate/_meta.js @@ -0,0 +1,5 @@ +export default { + // exclude routes until content published + // setup_sub_layer: "Setup Submission Layer", + // management: "Management", +}; diff --git a/app/journeys/co-ordinate/management/page.mdx b/app/journeys/co-ordinate/management/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/co-ordinate/management/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/co-ordinate/page.mdx b/app/journeys/co-ordinate/page.mdx new file mode 100644 index 0000000..3baa4c5 --- /dev/null +++ b/app/journeys/co-ordinate/page.mdx @@ -0,0 +1,11 @@ +--- +docType: journey +title: Co-ordinate +asIndexPage: true +--- + +# Co-ordinate + +import {UnderConstruction} from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/co-ordinate/setup-submission/page.mdx b/app/journeys/co-ordinate/setup-submission/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/co-ordinate/setup-submission/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/connect/page.mdx b/app/journeys/connect/page.mdx new file mode 100644 index 0000000..8acc535 --- /dev/null +++ b/app/journeys/connect/page.mdx @@ -0,0 +1,9 @@ +--- +docType: journey +title: Connect +asIndexPage: true +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/connect/tre-data-access/page.mdx b/app/journeys/connect/tre-data-access/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/connect/tre-data-access/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/contribute/components-architecture/page.mdx b/app/journeys/contribute/components-architecture/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/contribute/components-architecture/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/contribute/contributing-guide/page.mdx b/app/journeys/contribute/contributing-guide/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/contribute/contributing-guide/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/contribute/page.mdx b/app/journeys/contribute/page.mdx new file mode 100644 index 0000000..b542963 --- /dev/null +++ b/app/journeys/contribute/page.mdx @@ -0,0 +1,11 @@ +--- +docType: journey +title: Contribute +asIndexPage: true +--- + +# Contribute + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/contribute/setup-devenv/page.mdx b/app/journeys/contribute/setup-devenv/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/contribute/setup-devenv/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/contribute/system-architecture/page.mdx b/app/journeys/contribute/system-architecture/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/contribute/system-architecture/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/integrate/egress-api-reference/page.mdx b/app/journeys/integrate/egress-api-reference/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/integrate/egress-api-reference/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/integrate/explore-and-test-locally/page.mdx b/app/journeys/integrate/explore-and-test-locally/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/integrate/explore-and-test-locally/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/integrate/infrastructure-architecture/page.mdx b/app/journeys/integrate/infrastructure-architecture/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/integrate/infrastructure-architecture/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/integrate/page.mdx b/app/journeys/integrate/page.mdx new file mode 100644 index 0000000..c7e50e5 --- /dev/null +++ b/app/journeys/integrate/page.mdx @@ -0,0 +1,11 @@ +--- +docType: journey +title: Integrate +asIndexPage: true +--- + +# Integrate + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/integrate/setup-testenv/page.mdx b/app/journeys/integrate/setup-testenv/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/integrate/setup-testenv/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/integrate/submission-api-reference/page.mdx b/app/journeys/integrate/submission-api-reference/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/integrate/submission-api-reference/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/integrate/tre-agent-api-reference/page.mdx b/app/journeys/integrate/tre-agent-api-reference/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/integrate/tre-agent-api-reference/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/learn/omop/page.mdx b/app/journeys/learn/omop/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/learn/omop/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/learn/page.mdx b/app/journeys/learn/page.mdx new file mode 100644 index 0000000..4250835 --- /dev/null +++ b/app/journeys/learn/page.mdx @@ -0,0 +1,11 @@ +--- +docType: journey +title: Learn +asIndexPage: true +--- + +# Learn + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/learn/personas/page.mdx b/app/journeys/learn/personas/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/learn/personas/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/learn/system-architecture/page.mdx b/app/journeys/learn/system-architecture/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/learn/system-architecture/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/learn/what-is-five-safes/page.mdx b/app/journeys/learn/what-is-five-safes/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/learn/what-is-five-safes/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/research/analysis-examples/page.mdx b/app/journeys/research/analysis-examples/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/research/analysis-examples/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/research/page.mdx b/app/journeys/research/page.mdx new file mode 100644 index 0000000..1748214 --- /dev/null +++ b/app/journeys/research/page.mdx @@ -0,0 +1,11 @@ +--- +docType: journey +title: Research +asIndexPage: true +--- + +# Research + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/journeys/research/submitting-an-analysis/page.mdx b/app/journeys/research/submitting-an-analysis/page.mdx new file mode 100644 index 0000000..5ba0197 --- /dev/null +++ b/app/journeys/research/submitting-an-analysis/page.mdx @@ -0,0 +1,7 @@ +--- +# TODO: move to correct structure when content added +--- + +import { UnderConstruction } from "@/components/UnderConstruction"; + + \ No newline at end of file diff --git a/app/layout.tsx b/app/layout.tsx index 711384e..2e358f0 100644 --- a/app/layout.tsx +++ b/app/layout.tsx @@ -3,7 +3,7 @@ import { Head } from "nextra/components"; import { getPageMap } from "nextra/page-map"; import "nextra-theme-docs/style.css"; import "./globals.css"; -import { FooterLogo } from "@/components/footer-logo"; +import { FooterLogo } from "@/components/FooterLogo"; export const metadata = { // Define your metadata here diff --git a/app/page.mdx b/app/page.mdx index c7b8dc1..0bc06c0 100644 --- a/app/page.mdx +++ b/app/page.mdx @@ -1,93 +1,95 @@ -import { Cards } from "nextra/components"; import { Merge, - BookOpenIcon, + BookOpen, Unplug, Share2, Microscope, Boxes, + ChevronRight } from "lucide-react"; -import CustomCard from "@/components/custom-card"; +import CustomCard from "@/components/CustomCard"; -# Documentation +# Five Safes TES Documentation
- ", href: "/cta" }} - icon={} + CTA={{ text: <>Learn , href: "/journeys/learn" }} + icon={} /> + ", href: "/cta" }} + CTA={{ text: <>Connect , href: "/journeys/connect" }} icon={} + /> -/> + Research , href: "/journeys/research" }} + icon={} + /> -", href: "/cta" }} - icon={} -/> + Co-ordinate , href: "/journeys/co-ordinate" }} + icon={} + /> - ", href: "/cta" }} + CTA={{ text: <>Integrate , href: "/journeys/integrate" }} icon={} -/> - -", href: "/cta" }} - icon={} -/> -", href: "/cta" }} - icon={} -/> + /> + Contribute , href: "/journeys/contribute" }} + icon={} + />
diff --git a/components/custom-card.tsx b/components/CustomCard.tsx similarity index 85% rename from components/custom-card.tsx rename to components/CustomCard.tsx index 7c9b29e..20d7707 100644 --- a/components/custom-card.tsx +++ b/components/CustomCard.tsx @@ -1,10 +1,12 @@ +import { ReactNode } from "react"; + type LinksList = { title: string; href: string; }[]; type CtaType = { - text: string; + text: ReactNode; href: string; }; export default function CustomCard({ title, links, description, CTA, icon }: { title: string, description: string, links: LinksList, CTA: CtaType, icon: React.ReactNode }) { @@ -24,7 +26,7 @@ export default function CustomCard({ title, links, description, CTA, icon }: { t ))} - {CTA.text} + {CTA.text} ); } \ No newline at end of file diff --git a/components/footer-logo.tsx b/components/FooterLogo.tsx similarity index 100% rename from components/footer-logo.tsx rename to components/FooterLogo.tsx diff --git a/components/UnderConstruction.tsx b/components/UnderConstruction.tsx new file mode 100644 index 0000000..8fe86ec --- /dev/null +++ b/components/UnderConstruction.tsx @@ -0,0 +1,14 @@ +import construction from "@/public/images/construction.jpg" +import Image from "next/image" + +export function UnderConstruction() { + + return
+

Sorry!

+ Under Construction image with yellow and black striped warning barriers and an orange and white traffic cone in front +

We're still working on this page.

+
+ +} \ No newline at end of file diff --git a/public/images/construction.jpg b/public/images/construction.jpg new file mode 100644 index 0000000..05887d0 Binary files /dev/null and b/public/images/construction.jpg differ