diff --git a/docs/about/attribution.md b/docs/about/attribution.md index 3365e47..387060e 100644 --- a/docs/about/attribution.md +++ b/docs/about/attribution.md @@ -7,6 +7,12 @@ This site, and all StarCat Systems projects, products, and services make use of - [`about` repo](https://git.starcat.systems/starcatsys/about) icon - adapted from [Book](https://thenounproject.com/icon/book-1833960/) by [Untashable](https://thenounproject.com/creator/untashable/) from Noun Project. - [`starcat-infra` org](https://git.starcat.systems/starcat-infra) icon - adapted from [Engineering](https://thenounproject.com/icon/engineering-7486606/) by [sunardi](https://thenounproject.com/creator/matah3574/) from Noun Project. - Icons used on this `about` site are by [Material Design](https://pictogrammers.com/library/mdi/), [FontAwesome](https://fontawesome.com/search?m=free), [Octicons](https://octicons.github.com/), and [Simple Icons](https://simpleicons.org/). +- StarCat Cloud icon - adapted from [cloud](https://primer.style/octicons/icon/cloud-16/) by [Octicons](https://octicons.github.com/). - [SourceCamp](https://source.camp) logo - adapted from [camp](https://thenounproject.com/icon/camp-7375488/) by [Ricons](https://thenounproject.com/creator/ricons/) from Noun Project. - [DocsHub](https://docshub.io) logo - adapted from [Document](https://thenounproject.com/icon/document-6244658/) by [Reion](https://thenounproject.com/creator/dickydante/) from Noun Project. -- [StageLink](https://stagelink.cloud) logo - adapted from [slider](https://thenounproject.com/icon/slider-2309209/) by [DinosoftLabs](https://thenounproject.com/creator/dinosoftlab/) from Noun Project. \ No newline at end of file +- [StageLink](https://stagelink.cloud) logo - adapted from [slider](https://thenounproject.com/icon/slider-2309209/) by [DinosoftLabs](https://thenounproject.com/creator/dinosoftlab/) from Noun Project. + + +## Images +- [StarCat Systems](https://starcat.systems) landing page background - generated with [Haikei](https://haikei.app/). +- [StageLink](https://stagelink.cloud) landing page background - generated with [BGJar](https://bgjar.com). \ No newline at end of file diff --git a/docs/handbook/.nav.yml b/docs/handbook/.nav.yml index e47379d..473cd25 100644 --- a/docs/handbook/.nav.yml +++ b/docs/handbook/.nav.yml @@ -2,4 +2,5 @@ title: Handbook nav: - index.md - meta - - infrastructure \ No newline at end of file + - infrastructure + - branding \ No newline at end of file diff --git a/docs/handbook/branding/.nav.yml b/docs/handbook/branding/.nav.yml new file mode 100644 index 0000000..bfc4c0e --- /dev/null +++ b/docs/handbook/branding/.nav.yml @@ -0,0 +1,6 @@ +title: Branding +nav: + - index.md + - starcatsys.md + - docshub.md + - stagelink.md \ No newline at end of file diff --git a/docs/handbook/branding/docshub.md b/docs/handbook/branding/docshub.md new file mode 100644 index 0000000..c286974 --- /dev/null +++ b/docs/handbook/branding/docshub.md @@ -0,0 +1,26 @@ +# DocsHub + +## Logo +[:material-folder-lock: Logos > DocsHub](https://cloud.starcatsys.net/f/1175) + +Adapted from [Document](https://thenounproject.com/icon/document-6244658/) by [Reion](https://thenounproject.com/creator/dickydante/) from Noun Project. + +## Colors +### Primary Colors +**Primary blue**: `#1C76B8` blue + +### Website Colors +**Background**: `#1C76B8` blue +**Logo**: `#FFFFFF` blue +**Text**: `#FFFFFFC4` blue +**Text highlight-text**: `#000000` blue +**Text highlight-surround**: `#FFFF00` blue +**Button**: `#FFFF00` blue +**Button hover**: `#23A1FC` blue + +## Backgrounds +### Website Background +The DocsHub website uses a solid color background. + +## Fonts +The DocsHub logo and [:octicons-tab-external-16: landing page](https://docshub.io) both use *Space Mono* by Colophon Foundry for its primary font: [:octicons-link-external-16: Google Fonts - Space Mono](https://fonts.google.com/specimen/Space+Mono) \ No newline at end of file diff --git a/docs/handbook/branding/index.md b/docs/handbook/branding/index.md new file mode 100644 index 0000000..5676638 --- /dev/null +++ b/docs/handbook/branding/index.md @@ -0,0 +1,13 @@ +# Branding + +Branding information for the various StarCat Systems projects. + +!!! abstract "Placeholder Page" + This is a placeholder page. Please see the site navigation for any sub-pages that exist. + +--- + +!!! example "Work in Progress" + This page is not complete, and is subject to change. + + Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about) for this site. \ No newline at end of file diff --git a/docs/handbook/branding/stagelink.md b/docs/handbook/branding/stagelink.md new file mode 100644 index 0000000..655fc17 --- /dev/null +++ b/docs/handbook/branding/stagelink.md @@ -0,0 +1,33 @@ +# StageLink + +## Logo +[:material-folder-lock: Logos > StageLink](https://cloud.starcatsys.net/f/929) + +Adapted from [slider](https://thenounproject.com/icon/slider-2309209/) by [DinosoftLabs](https://thenounproject.com/creator/dinosoftlab/) from Noun Project + +## Colors +### Primary Colors +**Primary**: `#004080` blue +**Background**: Center box: `#FEFFFFD9` blue + +### Website Colors +**Logo**: `#004080` blue +**Background**: Center box: `#FEFFFFD9` blue +**Text**: `#004080` blue +**Button**: `#004080` blue +**Button hover**: `#0071FF` blue + +## Backgrounds +### Website Background +[:material-folder-lock: Backgrounds > StageLink](https://cloud.starcatsys.net/f/857) + +The StageLink [:octicons-tab-external-16: landing page](https://stagelink.cloud) background is generated with [:octicons-link-external-16: BGJar - Polygon Luminary](https://bgjar.com/polygon-luminary). + +**Width**: `1920 px` +**Height**: `1080 px` +**Background**: Simple, `#FFFFFF` blue +**Primary Color**: `#29DAFF` blue +**Secondary Color**: `#A7F0FF` blue + +## Fonts +The StageLink logo and [:octicons-tab-external-16: landing page](https://stagelink.cloud) both use *Roboto* by Christian Robertson, Paratype, Font Bureau for its primary font: [:octicons-link-external-16: Google Fonts - Roboto](https://fonts.google.com/specimen/Roboto) \ No newline at end of file diff --git a/docs/handbook/branding/starcatsys.md b/docs/handbook/branding/starcatsys.md new file mode 100644 index 0000000..18d5850 --- /dev/null +++ b/docs/handbook/branding/starcatsys.md @@ -0,0 +1,38 @@ +# StarCat Systems + +## Logo +[:material-folder-lock: Logos > StarCat Systems](https://cloud.starcatsys.net/f/1067) + +Adapted from [Cat](https://thenounproject.com/icon/cat-6441095/) by [Md Ahasan Habib](https://thenounproject.com/creator/md_ahasan/) from Noun Project. + +## Colors +### Primary Colors +**Primary bright blue**: `#00FFFF` blue +**Dark background purple**: `#2A0037` blue +**Lighter background purple**: `#4A007A` blue + +### Website Colors +**Logo**: `#00FFFF` blue +**Primary text**: `#66D9FF` blue +**Link**: `#00FFFF` blue +**Link hover**: `#CCFFFF` blue +**Footer**: `#33BBFF` blue + +## Backgrounds +### Website Background +[:material-folder-lock: Backgrounds > StarCat Systems](https://cloud.starcatsys.net/f/866) + +The StarCat Systems [:octicons-tab-external-16: landing page](https://starcat.systems) background is generated with [:octicons-link-external-16: Haikei](https://haikei.app/). + +**Style**: Layered Waves +**Color direction**: Option 3 (dark outer, light inner) +**Background**: `#2A0037` blue +**Wave color 1**: `#9E25F8` blue +**Wave color 2**: `#7317B2` blue + +## Fonts +### Logo Font +The StarCat Systems logo uses *Exo 2* by Natanael Gama for its primary font: [:octicons-link-external-16: Google Fonts - Exo 2](https://fonts.google.com/specimen/Exo+2) + +### Website Font +The StarCat Systems [:octicons-tab-external-16: landing page](https://starcat.systems) uses *Roboto* by Christian Robertson, Paratype, Font Bureau for its primary font: [:octicons-link-external-16: Google Fonts - Roboto](https://fonts.google.com/specimen/Roboto) \ No newline at end of file diff --git a/docs/handbook/infrastructure/.nav.yml b/docs/handbook/infrastructure/.nav.yml index 0b03573..e98c7be 100644 --- a/docs/handbook/infrastructure/.nav.yml +++ b/docs/handbook/infrastructure/.nav.yml @@ -3,6 +3,7 @@ nav: - index.md - servers_and_hosting - network + - storage - communication - monitoring - naming_conventions.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/storage/.nav.yml b/docs/handbook/infrastructure/storage/.nav.yml new file mode 100644 index 0000000..7aa06b1 --- /dev/null +++ b/docs/handbook/infrastructure/storage/.nav.yml @@ -0,0 +1,4 @@ +title: Storage +nav: + - index.md + - nextcloud.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/storage/index.md b/docs/handbook/infrastructure/storage/index.md new file mode 100644 index 0000000..2ff52f3 --- /dev/null +++ b/docs/handbook/infrastructure/storage/index.md @@ -0,0 +1,11 @@ +# Storage + +!!! abstract "Placeholder Page" + This is a placeholder page. Please see the site navigation for any sub-pages that exist. + +--- + +!!! example "Work in Progress" + This page is not complete, and is subject to change. + + Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/storage/nextcloud.md b/docs/handbook/infrastructure/storage/nextcloud.md new file mode 100644 index 0000000..704d10c --- /dev/null +++ b/docs/handbook/infrastructure/storage/nextcloud.md @@ -0,0 +1,14 @@ +# Nextcloud + +We use a Nextcloud instance as our internal "cloud" for file hosting and sharing. + +**URL**: [:octicons-tab-external-16: cloud.starcatsys.net](https://cloud.starcatsys.net) +**Homepage**: [:octicons-link-external-16: nextcloud.com](https://nextcloud.com/) +**Hosting**: [:octicons-arrow-right-16: Hetzner](../servers_and_hosting/hetzner.md) `FSN` + +--- + +!!! example "Work in Progress" + This page is not complete, and is subject to change. + + Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about) for this site. \ No newline at end of file diff --git a/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md b/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md index 32060d7..4269a8e 100644 --- a/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md +++ b/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md @@ -5,7 +5,7 @@ There might be a little bit of content here, but nothing substantial. -This is an example page to show the [:octicons-arrow-right-16: Placeholder Page admonition](../editing.md#placeholder-page). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about/src/branch/main/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md). +This is an example page to show the [:octicons-arrow-right-16: Placeholder Page admonition](../syntax.md#placeholder-page). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about/src/branch/main/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md). --- -Typically, you would also place a [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress) on this page, as it is incomplete. For an example of a full Placeholder and WIP page, see [text](example_wip_placeholder_admonitions.md) \ No newline at end of file +Typically, you would also place a [:octicons-arrow-right-16: Work in Progress admonition](../syntax.md#work-in-progress) on this page, as it is incomplete. For an example of a full Placeholder and WIP page, see [text](example_wip_placeholder_admonitions.md) \ No newline at end of file diff --git a/docs/handbook/meta/example_pages/example_wip_admonition.md b/docs/handbook/meta/example_pages/example_wip_admonition.md index 98cfdd4..452e379 100644 --- a/docs/handbook/meta/example_pages/example_wip_admonition.md +++ b/docs/handbook/meta/example_pages/example_wip_admonition.md @@ -1,5 +1,5 @@ # Example page: WIP admonition -This is an example page to show the [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress) (scroll down to the bottom!). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about/src/branch/main/docs/handbook/meta/example_pages/example_wip_admonition.md). +This is an example page to show the [:octicons-arrow-right-16: Work in Progress admonition](../syntax.md#work-in-progress) (scroll down to the bottom!). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about/src/branch/main/docs/handbook/meta/example_pages/example_wip_admonition.md). Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere, urna a tristique hendrerit, felis elit viverra diam, vel porta ante dui a nisi. Aenean mattis nibh est, vitae tristique enim pretium et. Maecenas quis purus egestas, rutrum dolor quis, ultricies neque. Vivamus sit amet lectus ligula. Etiam scelerisque leo odio, quis suscipit felis porttitor semper. Integer eu enim vehicula, molestie elit fringilla, porttitor quam. Ut consectetur feugiat tincidunt. diff --git a/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md b/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md index 50c9ceb..ce5839b 100644 --- a/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md +++ b/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md @@ -3,7 +3,7 @@ !!! abstract "Placeholder Page" This is a placeholder page. Please see the site navigation for any sub-pages that exist. -This is an example page to show both the [:octicons-arrow-right-16: Placeholder Page admonition](../editing.md#placeholder-page) and the [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress) (scroll down to the bottom!). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about/src/branch/main/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md). +This is an example page to show both the [:octicons-arrow-right-16: Placeholder Page admonition](../syntax.md#placeholder-page) and the [:octicons-arrow-right-16: Work in Progress admonition](../syntax.md#work-in-progress) (scroll down to the bottom!). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about/src/branch/main/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md). --- !!! example "Work in Progress" diff --git a/docs/handbook/meta/syntax.md b/docs/handbook/meta/syntax.md index 794f544..36ab0e9 100644 --- a/docs/handbook/meta/syntax.md +++ b/docs/handbook/meta/syntax.md @@ -9,7 +9,8 @@ Reference for all available Material for MkDocs icons: [:simple-materialformkdoc :octicons-arrow-right-16: `:octicons-arrow-right-16:` - used for links within the wiki :octicons-tab-external-16: `:octicons-tab-external-16:` - used for links outside the wiki, but within StarCat Systems :octicons-link-external-16: `:octicons-link-external-16:` - used for external links to sites not controlled by StarCat Systems -:material-book-lock: `:material-book-lock:` - used for links to the StarCat Systems internal handbook +:material-book-lock: `:material-book-lock:` - used for links to the StarCat Systems internal handbook +:material-folder-lock: `:material-folder-lock:` - used for restricted links to files hosted on StarCat Cloud. ### Coloring icons You can add a color to an icon by adding the CSS color after the icon, like this: