From f959f2de85d2e673291cd95cac7c45841dc3bb7d Mon Sep 17 00:00:00 2001 From: aviv926 <51673860+aviv926@users.noreply.github.com> Date: Mon, 15 Apr 2024 20:05:03 +0300 Subject: [PATCH] docs: community guides (#8812) * Community Guides * typo * chore: view guide --------- Co-authored-by: Jason Rasmussen --- docs/docs/community-guides.mdx | 12 +++++ docs/src/components/community-guides.tsx | 66 ++++++++++++++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 docs/docs/community-guides.mdx create mode 100644 docs/src/components/community-guides.tsx diff --git a/docs/docs/community-guides.mdx b/docs/docs/community-guides.mdx new file mode 100644 index 0000000000000..505ec93e7784f --- /dev/null +++ b/docs/docs/community-guides.mdx @@ -0,0 +1,12 @@ +# Community Guides + +This page lists community guides that are written around Immich, but not officially supported by the development team. + +:::warning +This list comes with no guarantees about security, performance, reliability, or accuracy. Use at your own risk. +::: + +import CommunityGuides from '../src/components/community-guides.tsx'; +import React from 'react'; + + diff --git a/docs/src/components/community-guides.tsx b/docs/src/components/community-guides.tsx new file mode 100644 index 0000000000000..b3da8575f9862 --- /dev/null +++ b/docs/src/components/community-guides.tsx @@ -0,0 +1,66 @@ +import Link from '@docusaurus/Link'; +import React from 'react'; + +interface CommunityGuidesProps { + title: string; + description: string; + url: string; +} + +const guides: CommunityGuidesProps[] = [ + { + title: 'Cloudflare Tunnels with SSO/OAuth', + description: `Setting up Cloudflare Tunnels and a SaaS App for immich.`, + url: 'https://github.com/immich-app/immich/discussions/8299', + }, + { + title: 'Database backup in Truenas', + description: `Create a database backup with pgAdmin in Truenas.`, + url: 'https://github.com/immich-app/immich/discussions/8809', + }, + { + title: 'Unraid backup scripts', + description: `Back up your assets in Unarid with a pre-prepared script.`, + url: 'https://github.com/immich-app/immich/discussions/8416', + }, + { + title: 'Sync folders with albums', + description: `synchronize folders in imported library with albums having the folders name.`, + url: 'https://github.com/immich-app/immich/discussions/3382', + }, +]; + +function CommunityGuide({ title, description, url }: CommunityGuidesProps): JSX.Element { + return ( +
+
+

+ {title} +

+ +

{description}

+

+ {url} +

+
+
+ + View Guide + +
+
+ ); +} + +export default function CommunityGuides(): JSX.Element { + return ( +
+ {guides.map((guides) => ( + + ))} +
+ ); +}