initial commit
This commit is contained in:
commit
5bf94983c5
3
.gitignore
vendored
Normal file
3
.gitignore
vendored
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
*.swp
|
||||||
|
public/
|
||||||
|
resources/
|
3
.gitmodules
vendored
Normal file
3
.gitmodules
vendored
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
[submodule "themes/book"]
|
||||||
|
path = themes/book
|
||||||
|
url = https://github.com/alex-shpak/hugo-book
|
13
LICENSE
Normal file
13
LICENSE
Normal file
@ -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.
|
5
README.md
Normal file
5
README.md
Normal file
@ -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.
|
6
archetypes/default.md
Normal file
6
archetypes/default.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
title: "{{ replace .Name "-" " " | title }}"
|
||||||
|
date: {{ .Date }}
|
||||||
|
draft: true
|
||||||
|
---
|
||||||
|
|
1
assets/scss/book.scss
Symbolic link
1
assets/scss/book.scss
Symbolic link
@ -0,0 +1 @@
|
|||||||
|
../../themes/book/assets/book.scss
|
98
config.toml
Normal file
98
config.toml
Normal file
@ -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
|
12
content/_index.md
Normal file
12
content/_index.md
Normal file
@ -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 >}}
|
9
content/docs/admin/_index.md
Normal file
9
content/docs/admin/_index.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
---
|
||||||
|
weight: 20
|
||||||
|
bookFlatSection: true
|
||||||
|
bookCollapseSection: true
|
||||||
|
title: "admin"
|
||||||
|
---
|
||||||
|
|
||||||
|
# admin
|
||||||
|
documentation of administrative tasks
|
7
content/docs/admin/nebula/_index.md
Normal file
7
content/docs/admin/nebula/_index.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
weight: 10
|
||||||
|
title: nebula
|
||||||
|
---
|
||||||
|
|
||||||
|
# nebula docs
|
||||||
|
*stuff running on nebula*
|
9
content/docs/admin/nebula/dns.md
Normal file
9
content/docs/admin/nebula/dns.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
---
|
||||||
|
title: dns
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
# dns
|
||||||
|
*dns-related docs*
|
||||||
|
|
||||||
|
bind-configs repo:\
|
||||||
|
⇒ https://git.dotya.ml/dotya.ml/bind-configs
|
16
content/docs/admin/nebula/drone.md
Normal file
16
content/docs/admin/nebula/drone.md
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
title: drone
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
# drone
|
||||||
|
*drone instance docs*
|
||||||
|
|
||||||
|
## server
|
||||||
|
|
||||||
|
## runners
|
||||||
|
|
||||||
|
### docker-runner
|
||||||
|
|
||||||
|
#### general
|
||||||
|
|
||||||
|
#### main
|
11
content/docs/admin/nebula/gitea.md
Normal file
11
content/docs/admin/nebula/gitea.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
---
|
||||||
|
title: gitea
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
# gitea
|
||||||
|
*gitea docs*
|
||||||
|
|
||||||
|
### building
|
||||||
|
### testing
|
||||||
|
### staging
|
||||||
|
### updating
|
6
content/docs/admin/nebula/systemd.md
Normal file
6
content/docs/admin/nebula/systemd.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
title: systemd
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
# systemd
|
||||||
|
*nebulas systemd units management docs*
|
6
content/docs/admin/nebula/tmate.md
Normal file
6
content/docs/admin/nebula/tmate.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
title: tmate
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
# tmate
|
||||||
|
*tmate-related docs*
|
6
content/docs/user/_index.md
Normal file
6
content/docs/user/_index.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
weight: 1
|
||||||
|
bookFlatSection: true
|
||||||
|
title: "user"
|
||||||
|
---
|
||||||
|
# user docs
|
7
content/docs/user/drone/_index.md
Normal file
7
content/docs/user/drone/_index.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
weight: 10
|
||||||
|
title: drone
|
||||||
|
---
|
||||||
|
# drone
|
||||||
|
|
||||||
|
*drone user documentation*
|
11
content/docs/user/gitea/_index.md
Normal file
11
content/docs/user/gitea/_index.md
Normal file
@ -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 >}}
|
7
content/docs/user/gitea/anything.md
Normal file
7
content/docs/user/gitea/anything.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
title: anything else
|
||||||
|
weight: 2
|
||||||
|
bookToc: false
|
||||||
|
---
|
||||||
|
|
||||||
|
# anything
|
6
content/docs/user/gitea/why-to-add-ssh-keys.md
Normal file
6
content/docs/user/gitea/why-to-add-ssh-keys.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
title: why to add ssh keys
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
# why bother?
|
||||||
|
*explain why bother adding ssh keys*
|
14
content/docs/user/onion-services/_index.md
Normal file
14
content/docs/user/onion-services/_index.md
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
weight: 10
|
||||||
|
title: onion-services
|
||||||
|
---
|
||||||
|
# list of onion-services
|
||||||
|
*core*
|
||||||
|
* gitea
|
||||||
|
* drone (wip)
|
||||||
|
* prometheus
|
||||||
|
* grafana
|
||||||
|
* statping
|
||||||
|
|
||||||
|
*auxiliary*
|
||||||
|
* ...
|
10
content/docs/user/services/_index.md
Normal file
10
content/docs/user/services/_index.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
weight: 10
|
||||||
|
title: services
|
||||||
|
---
|
||||||
|
# list of services
|
||||||
|
* gitea
|
||||||
|
* drone
|
||||||
|
* prometheus
|
||||||
|
* grafana
|
||||||
|
* statping
|
1
themes/book
Submodule
1
themes/book
Submodule
@ -0,0 +1 @@
|
|||||||
|
Subproject commit 1e4bcc2cc3186794c1becbe0a0d9c924264d0146
|
Loading…
Reference in New Issue
Block a user