From 8450695f687a8227e3911e0b7af72a0edf10b785 Mon Sep 17 00:00:00 2001 From: Jan Halfar Date: Fri, 21 Apr 2023 23:40:31 +0200 Subject: [PATCH] feat: clean up uris --- foomo/docs/backend/{intro.mdx => index.mdx} | 4 ++-- foomo/docs/devops/index.md | 13 ++++++++++ foomo/docs/devops/intro.md | 7 ------ foomo/docs/frontend/{intro.md => index.md} | 7 +++--- foomo/docs/general/index.md | 23 ++++++++++++++++++ foomo/docs/general/intro.md | 24 ------------------- .../project-management/{intro.md => index.md} | 5 ++++ foomo/docs/projects/{intro.md => index.md} | 6 ++--- foomo/docusaurus.config.js | 12 +++++----- foomo/src/components/HomepageFeatures.tsx | 10 ++++---- foomo/src/components/Iframe.tsx | 12 +++++----- 11 files changed, 66 insertions(+), 57 deletions(-) rename foomo/docs/backend/{intro.mdx => index.mdx} (70%) create mode 100644 foomo/docs/devops/index.md delete mode 100644 foomo/docs/devops/intro.md rename foomo/docs/frontend/{intro.md => index.md} (95%) create mode 100644 foomo/docs/general/index.md delete mode 100644 foomo/docs/general/intro.md rename foomo/docs/project-management/{intro.md => index.md} (82%) rename foomo/docs/projects/{intro.md => index.md} (91%) diff --git a/foomo/docs/backend/intro.mdx b/foomo/docs/backend/index.mdx similarity index 70% rename from foomo/docs/backend/intro.mdx rename to foomo/docs/backend/index.mdx index 4df2efa..c69d05a 100644 --- a/foomo/docs/backend/intro.mdx +++ b/foomo/docs/backend/index.mdx @@ -1,10 +1,10 @@ --- -sidebar_label: Intro +id: index sidebar_position: 1 --- import { GoPlayground } from '../../src/components/GoPlayground'; -# building backend services with Go and foomo +# Backend Guide diff --git a/foomo/docs/devops/index.md b/foomo/docs/devops/index.md new file mode 100644 index 0000000..9d0bac1 --- /dev/null +++ b/foomo/docs/devops/index.md @@ -0,0 +1,13 @@ +--- +id: index +sidebar_position: 1 +--- + +# Devops Guide + +How to run apps with foomo in the cloud + +- manage your infrasture as code with terraform +- run apps on kubernetes +- use squadron to make k8s more accessible + diff --git a/foomo/docs/devops/intro.md b/foomo/docs/devops/intro.md deleted file mode 100644 index 1245914..0000000 --- a/foomo/docs/devops/intro.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sidebar_label: Intro -sidebar_position: 1 ---- - -# How we run applications in the cloud - diff --git a/foomo/docs/frontend/intro.md b/foomo/docs/frontend/index.md similarity index 95% rename from foomo/docs/frontend/intro.md rename to foomo/docs/frontend/index.md index 9b08122..94cc9cb 100644 --- a/foomo/docs/frontend/intro.md +++ b/foomo/docs/frontend/index.md @@ -1,11 +1,10 @@ --- -id: intro -sidebar_label: Intro +id: index sidebar_position: 1 --- # Frontend Guide -In this section you will find a guide on how to develop frontends with the foomo stack. Please also see the [general guide](../general/intro). +In this section you will find a guide on how to develop frontends with the foomo stack. Please also see the [general guide](general). Let me share a few thoughts on frontend development from our journey [@bestbytes](https://www.bestbytes.com) the company behind https://www.foomo.org . @@ -17,7 +16,7 @@ It was the era of experimentation, that turned the web into the application runt ## A little history -The current [stack](stack) is the result of a more than 20 year journey. +The current [stack](frontend/stack) is the result of a more than 20 year journey. ### Last millenium diff --git a/foomo/docs/general/index.md b/foomo/docs/general/index.md new file mode 100644 index 0000000..efc25b7 --- /dev/null +++ b/foomo/docs/general/index.md @@ -0,0 +1,23 @@ +--- +id: index +sidebar_position: 0 +--- + +# General guide + +This is a general guide for software developers. + +If you are looking for docs of the foomo project - start [here](projects) + +## Get started + +- [setup your workplace](general/setup/workplace) +- [security is always first](general/security) +- [setup your computer](general/setup/computer) +- [look at the essentials](general/essentials) +- [make sure you are using a package manager](general/package-managers) +- [install some awesome software](/awesome-software) +- [more for frontend devs](frontend) +- [more for backend devs](backend) +- [start exploring the foomo projects](projects) + diff --git a/foomo/docs/general/intro.md b/foomo/docs/general/intro.md deleted file mode 100644 index ea9a8a8..0000000 --- a/foomo/docs/general/intro.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: intro -sidebar_label: Intro -sidebar_position: 0 ---- - -# General guide - -This is a general guide for software developers. - -If you are looking for docs of the foomo project - start [here](../projects/intro) - -## Get started - -- [setup your workplace](setup/workplace) -- [security is always first](security) -- [setup your computer](setup/computer) -- [look at the essentials](essentials) -- [make sure you are using a package manager](package-managers) -- [install some awesome software](/awesome-software) -- [more for frontend devs](../frontend/intro) -- [more for backend devs](../backend/intro) -- [start exploring the foomo projects](../projects/intro) - diff --git a/foomo/docs/project-management/intro.md b/foomo/docs/project-management/index.md similarity index 82% rename from foomo/docs/project-management/intro.md rename to foomo/docs/project-management/index.md index 2b61530..8f1bbd3 100644 --- a/foomo/docs/project-management/intro.md +++ b/foomo/docs/project-management/index.md @@ -1,3 +1,8 @@ +--- +id: index +sidebar_position: 1 +--- + # Project Managament We [scrumming](https://www.scrum.org/) in our way ... diff --git a/foomo/docs/projects/intro.md b/foomo/docs/projects/index.md similarity index 91% rename from foomo/docs/projects/intro.md rename to foomo/docs/projects/index.md index 60ef90e..c51288a 100644 --- a/foomo/docs/projects/intro.md +++ b/foomo/docs/projects/index.md @@ -1,13 +1,13 @@ --- -id: intro -sidebar_label: Intro +id: index +sidebar_label: Overview sidebar_position: 0 --- # foomo project overview ___"Stuff we wrote, because nobody else wanted to"___ -All foomo projects are available here https://github.com/foomo also see [architecture](architecture) +All foomo projects are available here https://github.com/foomo also see [architecture](projects/architecture) We are using the best industry standards and only fill in our own bits, when necessary. diff --git a/foomo/docusaurus.config.js b/foomo/docusaurus.config.js index 75f3b51..e2ec7bf 100644 --- a/foomo/docusaurus.config.js +++ b/foomo/docusaurus.config.js @@ -68,39 +68,39 @@ const config = { items: [ { type: 'doc', - docId: 'general/intro', + docId: 'general/index', position: 'left', label: 'General', }, { type: 'doc', - docId: 'frontend/intro', + docId: 'frontend/index', position: 'left', label: 'Frontend', }, { type: 'doc', - docId: 'backend/intro', + docId: 'backend/index', position: 'left', label: 'Backend', }, { type: 'doc', - docId: 'devops/intro', + docId: 'devops/index', position: 'left', label: 'DevOps', }, { type: 'doc', - docId: 'project-management/intro', + docId: 'project-management/index', position: 'left', label: 'PM', }, { type: 'doc', - docId: 'projects/intro', + docId: 'projects/index', position: 'left', label: 'Projects', }, diff --git a/foomo/src/components/HomepageFeatures.tsx b/foomo/src/components/HomepageFeatures.tsx index bdb501d..90d2466 100644 --- a/foomo/src/components/HomepageFeatures.tsx +++ b/foomo/src/components/HomepageFeatures.tsx @@ -32,7 +32,7 @@ const FeatureList: FeatureItem[] = [ ), callToAction: "get started", - to: "/docs/general/intro", + to: "/docs/general", }, { title: "Frontend guides", @@ -43,21 +43,21 @@ const FeatureList: FeatureItem[] = [ ), callToAction: "go build a frontend", - to: "/docs/frontend/intro", + to: "/docs/frontend", }, { title: "Backend guides", // image: '/img/undraw_docusaurus_react.svg', description: <>Write fast and reliable services in Go and run them in the cloud, callToAction: "build a server", - to: "/docs/backend/intro", + to: "/docs/backend", }, { title: "Projects", // image: '/img/undraw_docusaurus_react.svg', description: <>Foomo projects - libraries, utilities, friendly daemons and more, callToAction: "explore", - to: "/docs/projects/intro", + to: "/docs/projects", }, { title: "CMS", @@ -89,7 +89,7 @@ const FeatureList: FeatureItem[] = [ // image: '/img/undraw_docusaurus_react.svg', description: <>our approach to run cloud native applications where they belong, callToAction: "take me to the cloud", - to: "/docs/devops/intro", + to: "/docs/devops", }, { title: "Blog", diff --git a/foomo/src/components/Iframe.tsx b/foomo/src/components/Iframe.tsx index 5a53a20..0e296db 100644 --- a/foomo/src/components/Iframe.tsx +++ b/foomo/src/components/Iframe.tsx @@ -1,16 +1,16 @@ import React from "react"; -export const Iframe = (props: { +export const Iframe = (props:React.PropsWithRef<{ proportion?: number; src: string; style?: React.CSSProperties; -}) => { - let { proportion, src } = props; +}> ) => { + let { proportion, src, style } = props; if (!proportion) { proportion = 4 / 3; } - if (!props.style) { - props.style = {}; + if (style) { + style = {}; } return ( @@ -21,7 +21,7 @@ export const Iframe = (props: { paddingTop: 100 / proportion + "%", position: "relative", float: "left", - ...props.style, + ...style, }} >