From 5bf94983c5ad6ab5cbb04b3007e27e3a29aadabb Mon Sep 17 00:00:00 2001 From: surtur Date: Sun, 14 Mar 2021 04:23:32 +0100 Subject: [PATCH] initial commit --- .gitignore | 3 + .gitmodules | 3 + LICENSE | 13 +++ README.md | 5 + archetypes/default.md | 6 ++ assets/scss/book.scss | 1 + config.toml | 98 +++++++++++++++++++ content/_index.md | 12 +++ content/docs/admin/_index.md | 9 ++ content/docs/admin/nebula/_index.md | 7 ++ content/docs/admin/nebula/dns.md | 9 ++ content/docs/admin/nebula/drone.md | 16 +++ content/docs/admin/nebula/gitea.md | 11 +++ content/docs/admin/nebula/systemd.md | 6 ++ content/docs/admin/nebula/tmate.md | 6 ++ content/docs/user/_index.md | 6 ++ content/docs/user/drone/_index.md | 7 ++ content/docs/user/gitea/_index.md | 11 +++ content/docs/user/gitea/anything.md | 7 ++ .../docs/user/gitea/why-to-add-ssh-keys.md | 6 ++ content/docs/user/onion-services/_index.md | 14 +++ content/docs/user/services/_index.md | 10 ++ themes/book | 1 + 23 files changed, 267 insertions(+) create mode 100644 .gitignore create mode 100644 .gitmodules create mode 100644 LICENSE create mode 100644 README.md create mode 100644 archetypes/default.md create mode 120000 assets/scss/book.scss create mode 100644 config.toml create mode 100644 content/_index.md create mode 100644 content/docs/admin/_index.md create mode 100644 content/docs/admin/nebula/_index.md create mode 100644 content/docs/admin/nebula/dns.md create mode 100644 content/docs/admin/nebula/drone.md create mode 100644 content/docs/admin/nebula/gitea.md create mode 100644 content/docs/admin/nebula/systemd.md create mode 100644 content/docs/admin/nebula/tmate.md create mode 100644 content/docs/user/_index.md create mode 100644 content/docs/user/drone/_index.md create mode 100644 content/docs/user/gitea/_index.md create mode 100644 content/docs/user/gitea/anything.md create mode 100644 content/docs/user/gitea/why-to-add-ssh-keys.md create mode 100644 content/docs/user/onion-services/_index.md create mode 100644 content/docs/user/services/_index.md create mode 160000 themes/book diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7eb9e05 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*.swp +public/ +resources/ diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..1d95c41 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "themes/book"] + path = themes/book + url = https://github.com/alex-shpak/hugo-book diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..31c4858 --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + Version 2, December 2004 + + Copyright (C) 2019-2021 dotya.ml authors + + Everyone is permitted to copy and distribute verbatim or modified + copies of this license document, and changing it is allowed as long + as the name is changed. + + DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. You just DO WHAT THE FUCK YOU WANT TO. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f39eee4 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# docs + +sawce of the dotya.ml's docs site. + +Built with [Hugo](https://gohugo.io) on [Book]( https://github.com/alex-shpak/hugo-book) theme. diff --git a/archetypes/default.md b/archetypes/default.md new file mode 100644 index 0000000..00e77bd --- /dev/null +++ b/archetypes/default.md @@ -0,0 +1,6 @@ +--- +title: "{{ replace .Name "-" " " | title }}" +date: {{ .Date }} +draft: true +--- + diff --git a/assets/scss/book.scss b/assets/scss/book.scss new file mode 120000 index 0000000..8084b82 --- /dev/null +++ b/assets/scss/book.scss @@ -0,0 +1 @@ +../../themes/book/assets/book.scss \ No newline at end of file diff --git a/config.toml b/config.toml new file mode 100644 index 0000000..779871f --- /dev/null +++ b/config.toml @@ -0,0 +1,98 @@ +baseURL = "docs.dotya.ml" +languageCode = "en-gb" +title = "dotya.ml Docs" + +theme = 'book' + +# (Optional) Set this to true if you use capital letters in file names +disablePathToLower = false +enableGitInfo = true +disableKinds = ['taxonomy', 'taxonomyTerm'] + +# Needed for mermaid/katex shortcodes +[markup] +[markup.goldmark.renderer] + unsafe = true + +[markup.tableOfContents] + startLevel = 1 + +[languages] +[languages.en] + languageName = 'English' + contentDir = 'content' + weight = 1 + +[menu] +[[menu.after]] + name = "git.dotya.ml" + url = "https://git.dotya.ml" + weight = 10 + +[[menu.after]] + name = "dotya.ml's homepage" + url = "https://dotya.ml" + weight = 20 + + +[params] + # (Optional, default light) Sets color theme: light, dark or auto. + # Theme 'auto' switches between dark and light modes based on browser/os preferences + BookTheme = 'dark' + + # (Optional, default true) Controls table of contents visibility on right side of pages. + # Start and end levels can be controlled with markup.tableOfContents setting. + # You can also specify this parameter per page in front matter. + BookToC = true + + # (Optional, default none) Set the path to a logo for the book. If the logo is + # /static/logo.png then the path would be logo.png + # BookLogo = 'logo.png' + + # (Optional, default none) Set leaf bundle to render as side menu + # When not specified file structure and weights will be used + # BookMenuBundle = '/menu' + + # (Optional, default docs) Specify root page to render child pages as menu. + # Page is resoled by .GetPage function: https://gohugo.io/functions/getpage/ + # For backward compatibility you can set '*' to render all sections to menu. Acts same as '/' + BookSection = 'docs' + + # Set source repository location. + # Used for 'Last Modified' and 'Edit this page' links. + BookRepo = 'https://git.dotya.ml/dotya.ml/docs' + + # Enable "Edit this page" links for 'doc' page type. + # Disabled by default. Uncomment to enable. Requires 'BookRepo' param. + # Edit path must point to root directory of repo. + BookEditPath = './src/branch/master' + + # Configure the date format used on the pages + # - In git information + # - In blog posts + BookDateFormat = 'January 2, 2006' + + # (Optional, default true) Enables search function with flexsearch, + # Index is built on fly, therefore it might slowdown your website. + # Configuration for indexing can be adjusted in i18n folder per language. + BookSearch = true + + # (Optional, default true) Enables comments template on pages + # By default partals/docs/comments.html includes Disqus template + # See https://gohugo.io/content-management/comments/#configure-disqus + # Can be overwritten by same param in page frontmatter + BookComments = false + + # /!\ This is an experimental feature, might be removed or changed at any time + # (Optional, experimental, default false) Enables portable links and link checks in markdown pages. + # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode + # Theme will print warning if page referenced in markdown does not exists. + BookPortableLinks = true + + # /!\ This is an experimental feature, might be removed or changed at any time + # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use. + BookServiceWorker = false + + # /!\ This is an experimental feature, might be removed or changed at any time + # (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present. + BookTranslatedOnly = false diff --git a/content/_index.md b/content/_index.md new file mode 100644 index 0000000..354eca7 --- /dev/null +++ b/content/_index.md @@ -0,0 +1,12 @@ +--- +title: Introduction +type: docs +--- + +# Welcome to our docs! + +This site is a place for the documentation of [dotya.ml](https://dotya.ml)'s services - partly telling us what we've set up but mainly advising the users *how* the services can be used, providing helpful tips along the way. + +{{< hint info >}} +If you find something's missing or you just want to contribute, any **suggestions, patches or PRs are most welcome.** +{{< /hint >}} diff --git a/content/docs/admin/_index.md b/content/docs/admin/_index.md new file mode 100644 index 0000000..26d433a --- /dev/null +++ b/content/docs/admin/_index.md @@ -0,0 +1,9 @@ +--- +weight: 20 +bookFlatSection: true +bookCollapseSection: true +title: "admin" +--- + +# admin +documentation of administrative tasks diff --git a/content/docs/admin/nebula/_index.md b/content/docs/admin/nebula/_index.md new file mode 100644 index 0000000..0a1a3d1 --- /dev/null +++ b/content/docs/admin/nebula/_index.md @@ -0,0 +1,7 @@ +--- +weight: 10 +title: nebula +--- + +# nebula docs +*stuff running on nebula* diff --git a/content/docs/admin/nebula/dns.md b/content/docs/admin/nebula/dns.md new file mode 100644 index 0000000..626ffb7 --- /dev/null +++ b/content/docs/admin/nebula/dns.md @@ -0,0 +1,9 @@ +--- +title: dns +weight: 1 +--- +# dns +*dns-related docs* + +bind-configs repo:\ +⇒ https://git.dotya.ml/dotya.ml/bind-configs diff --git a/content/docs/admin/nebula/drone.md b/content/docs/admin/nebula/drone.md new file mode 100644 index 0000000..eb696df --- /dev/null +++ b/content/docs/admin/nebula/drone.md @@ -0,0 +1,16 @@ +--- +title: drone +weight: 1 +--- +# drone +*drone instance docs* + +## server + +## runners + +### docker-runner + +#### general + +#### main diff --git a/content/docs/admin/nebula/gitea.md b/content/docs/admin/nebula/gitea.md new file mode 100644 index 0000000..e2090f3 --- /dev/null +++ b/content/docs/admin/nebula/gitea.md @@ -0,0 +1,11 @@ +--- +title: gitea +weight: 1 +--- +# gitea +*gitea docs* + +### building +### testing +### staging +### updating diff --git a/content/docs/admin/nebula/systemd.md b/content/docs/admin/nebula/systemd.md new file mode 100644 index 0000000..046c932 --- /dev/null +++ b/content/docs/admin/nebula/systemd.md @@ -0,0 +1,6 @@ +--- +title: systemd +weight: 1 +--- +# systemd +*nebulas systemd units management docs* diff --git a/content/docs/admin/nebula/tmate.md b/content/docs/admin/nebula/tmate.md new file mode 100644 index 0000000..12724f8 --- /dev/null +++ b/content/docs/admin/nebula/tmate.md @@ -0,0 +1,6 @@ +--- +title: tmate +weight: 1 +--- +# tmate +*tmate-related docs* diff --git a/content/docs/user/_index.md b/content/docs/user/_index.md new file mode 100644 index 0000000..64443a0 --- /dev/null +++ b/content/docs/user/_index.md @@ -0,0 +1,6 @@ +--- +weight: 1 +bookFlatSection: true +title: "user" +--- +# user docs diff --git a/content/docs/user/drone/_index.md b/content/docs/user/drone/_index.md new file mode 100644 index 0000000..6dc4100 --- /dev/null +++ b/content/docs/user/drone/_index.md @@ -0,0 +1,7 @@ +--- +weight: 10 +title: drone +--- +# drone + +*drone user documentation* diff --git a/content/docs/user/gitea/_index.md b/content/docs/user/gitea/_index.md new file mode 100644 index 0000000..8d1f9f4 --- /dev/null +++ b/content/docs/user/gitea/_index.md @@ -0,0 +1,11 @@ +--- +weight: 10 +title: gitea +--- +# gitea + +*Gitea user documentation* +{{< hint info >}} +**note**\ +links to the [upstream project's original docs](https://docs.gitea.io) are provided wherever relevant so that we don't repeat the same things here +{{< /hint >}} diff --git a/content/docs/user/gitea/anything.md b/content/docs/user/gitea/anything.md new file mode 100644 index 0000000..446028c --- /dev/null +++ b/content/docs/user/gitea/anything.md @@ -0,0 +1,7 @@ +--- +title: anything else +weight: 2 +bookToc: false +--- + +# anything diff --git a/content/docs/user/gitea/why-to-add-ssh-keys.md b/content/docs/user/gitea/why-to-add-ssh-keys.md new file mode 100644 index 0000000..3609c80 --- /dev/null +++ b/content/docs/user/gitea/why-to-add-ssh-keys.md @@ -0,0 +1,6 @@ +--- +title: why to add ssh keys +weight: 1 +--- +# why bother? +*explain why bother adding ssh keys* diff --git a/content/docs/user/onion-services/_index.md b/content/docs/user/onion-services/_index.md new file mode 100644 index 0000000..83c016c --- /dev/null +++ b/content/docs/user/onion-services/_index.md @@ -0,0 +1,14 @@ +--- +weight: 10 +title: onion-services +--- +# list of onion-services +*core* +* gitea +* drone (wip) +* prometheus +* grafana +* statping + +*auxiliary* +* ... diff --git a/content/docs/user/services/_index.md b/content/docs/user/services/_index.md new file mode 100644 index 0000000..a4673fb --- /dev/null +++ b/content/docs/user/services/_index.md @@ -0,0 +1,10 @@ +--- +weight: 10 +title: services +--- +# list of services +* gitea +* drone +* prometheus +* grafana +* statping diff --git a/themes/book b/themes/book new file mode 160000 index 0000000..1e4bcc2 --- /dev/null +++ b/themes/book @@ -0,0 +1 @@ +Subproject commit 1e4bcc2cc3186794c1becbe0a0d9c924264d0146