From ec23d131b6def6f13096cbbbffc56b12b765a39d Mon Sep 17 00:00:00 2001 From: Thomas Boerger Date: Wed, 6 Nov 2019 10:08:06 +0100 Subject: [PATCH] Restructure styles within docs --- docs/.gitignore | 1 + docs/config.toml | 2 + docs/layouts/index.html | 4 +- docs/layouts/partials/style.html | 337 +-------------- docs/public/categories/index.xml | 14 - docs/public/index.html | 713 ------------------------------- docs/public/index.xml | 55 --- docs/public/sitemap.xml | 41 -- docs/public/syntax.css | 59 --- docs/public/tags/index.xml | 14 - docs/static/styles.css | 338 +++++++++++++++ 11 files changed, 344 insertions(+), 1234 deletions(-) create mode 100644 docs/.gitignore delete mode 100644 docs/public/categories/index.xml delete mode 100644 docs/public/index.html delete mode 100644 docs/public/index.xml delete mode 100644 docs/public/sitemap.xml delete mode 100644 docs/public/syntax.css delete mode 100644 docs/public/tags/index.xml create mode 100644 docs/static/styles.css diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..364fdec1a --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +public/ diff --git a/docs/config.toml b/docs/config.toml index a2e1ea6ab..27e1d4905 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -3,6 +3,8 @@ languageCode = "en-us" title = "ownCloud Infinite Scale: Phoenix" pygmentsUseClasses = true +disableKinds = ["taxonomy", "taxonomyTerm", "RSS", "sitemap"] + [blackfriday] angledQuotes = true fractions = false diff --git a/docs/layouts/index.html b/docs/layouts/index.html index f3dca91f1..27db113ac 100644 --- a/docs/layouts/index.html +++ b/docs/layouts/index.html @@ -38,7 +38,7 @@ {{ range .Data.Pages.ByWeight }}
-

+

{{ .Title }} @@ -48,7 +48,7 @@ Back to Top -

+ {{ .Content | markdownify }}
diff --git a/docs/layouts/partials/style.html b/docs/layouts/partials/style.html index cba6e127d..1386c59b0 100644 --- a/docs/layouts/partials/style.html +++ b/docs/layouts/partials/style.html @@ -1,337 +1,2 @@ - - + diff --git a/docs/public/categories/index.xml b/docs/public/categories/index.xml deleted file mode 100644 index 132e0c840..000000000 --- a/docs/public/categories/index.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - Categories on ownCloud Infinite Scale: Phoenix - https://owncloud.github.io/ocis-phoenix/categories/ - Recent content in Categories on ownCloud Infinite Scale: Phoenix - Hugo -- gohugo.io - en-us - - - - - - \ No newline at end of file diff --git a/docs/public/index.html b/docs/public/index.html deleted file mode 100644 index e68ab699f..000000000 --- a/docs/public/index.html +++ /dev/null @@ -1,713 +0,0 @@ - - - - - - - - - - ownCloud Infinite Scale: Phoenix - - - - - - - - - - - - - - - -
-

- - About - - - - - Back to Top - - -

- - TBD -
- -
-

- - Getting Started - - - - - Back to Top - - -

- -

Installation

- -

So far we are offering two different variants for the installation. You can choose between Docker or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.

- -

Docker

- -

TBD

- -

Binaries

- -

TBD

- -

Configuration

- -

We provide overall three different variants of configuration. The variant based on environment variables and commandline flags are split up into global values and command-specific values.

- -

Envrionment variables

- -

If you prefer to configure the service with environment variables you can see the available variables below.

- -

Global

- -
-
PHOENIX_LOG_LEVEL
-
Set logging level, defaults to info
-
-
PHOENIX_LOG_COLOR
-
Enable colored logging, defaults to true
-
-
PHOENIX_LOG_PRETTY
-
Enable pretty logging, defaults to true
-
-
- -

Server

- -
-
PHOENIX_DEBUG_ADDR
-
Address to bind debug server, defaults to 0.0.0.0:8090
-
-
PHOENIX_DEBUG_TOKEN
-
Token to grant metrics access, empty default value
-
-
PHOENIX_DEBUG_PPROF
-
Enable pprof debugging, defaults to false
-
-
PHOENIX_HTTP_ADDR
-
Address to bind http server, defaults to 0.0.0.0:8080
-
-
PHOENIX_HTTP_ROOT
-
Root path for http endpoint, defaults to /
-
-
PHOENIX_ASSET_PATH
-
Path to custom assets, empty default value
-
-
PHOENIX_CONFIG_FILE
-
Path to phoenix config, empty default value
-
-
- -

Health

- -
-
PHOENIX_DEBUG_ADDR
-
Address to debug endpoint, defaults to 0.0.0.0:8090
-
-
- -

Commandline flags

- -

If you prefer to configure the service with commandline flags you can see the available variables below.

- -

Global

- -
-
–log-level
-
Set logging level, defaults to info
-
-
–log-color
-
Enable colored logging, defaults to true
-
-
–log-pretty
-
Enable pretty logging, defaults to true
-
-
- -

Server

- -
-
–debug-addr
-
Address to bind debug server, defaults to 0.0.0.0:8090
-
-
–debug-token
-
Token to grant metrics access, empty default value
-
-
–debug-pprof
-
Enable pprof debugging, defaults to false
-
-
–http-addr
-
Address to bind http server, defaults to 0.0.0.0:8080
-
-
–http-root
-
Root path for http endpoint, defaults to /
-
-
–asset-path
-
Path to custom assets, empty default value
-
-
–config-file
-
Path to phoenix config, empty default value
-
-
- -

Health

- -
-
–debug-addr
-
Address to debug endpoint, defaults to 0.0.0.0:8090
-
-
- -

Configuration file

- -

So far we support the file formats JSON and YAML, if you want to get a full example configuration just take a look at our repository, there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it’s placed at /etc/ocis/phoenix.yml, ${HOME}/.ocis/phoenix.yml or $(pwd)/config/phoenix.yml.

- -

Usage

- -

The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via ocis-phoenix --help.

- -

Server

- -

The server command is used to start the http and debug server on two addresses within a single process. The http server is serving the general webservice while the debug server is used for health check, readiness check and to server the metrics mentioned below. For further help please execute:

- -
ocis-phoenix server --help
- -

Health

- -

The health command is used to execute a health check, if the exit code equals zero the service should be up and running, if the exist code is greater than zero the service is not in a healthy state. Generally this command is used within our Docker containers, it could also be used within Kubernetes.

- -
ocis-phoenix health --help
- -

Metrics

- -

This service provides some Prometheus metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag --debug-token or the environment variable PHOENIX_DEBUG_TOKEN mentioned above. By default the metrics endpoint is bound to http://0.0.0.0:8090/metrics.

- -
-
go_gc_duration_seconds
-
A summary of the GC invocation durations
-
-
go_gc_duration_seconds_sum
-
A summary of the GC invocation durations
-
-
go_gc_duration_seconds_count
-
A summary of the GC invocation durations
-
-
go_goroutines
-
Number of goroutines that currently exist
-
-
go_info
-
Information about the Go environment
-
-
go_memstats_alloc_bytes
-
Number of bytes allocated and still in use
-
-
go_memstats_alloc_bytes_total
-
Total number of bytes allocated, even if freed
-
-
go_memstats_buck_hash_sys_bytes
-
Number of bytes used by the profiling bucket hash table
-
-
go_memstats_frees_total
-
Total number of frees
-
-
go_memstats_gc_cpu_fraction
-
The fraction of this program’s available CPU time used by the GC since the program started
-
-
go_memstats_gc_sys_bytes
-
Number of bytes used for garbage collection system metadata
-
-
go_memstats_heap_alloc_bytes
-
Number of heap bytes allocated and still in use
-
-
go_memstats_heap_idle_bytes
-
Number of heap bytes waiting to be used
-
-
go_memstats_heap_inuse_bytes
-
Number of heap bytes that are in use
-
-
go_memstats_heap_objects
-
Number of allocated objects
-
-
go_memstats_heap_released_bytes
-
Number of heap bytes released to OS
-
-
go_memstats_heap_sys_bytes
-
Number of heap bytes obtained from system
-
-
go_memstats_last_gc_time_seconds
-
Number of seconds since 1970 of last garbage collection
-
-
go_memstats_lookups_total
-
Total number of pointer lookups
-
-
go_memstats_mallocs_total
-
Total number of mallocs
-
-
go_memstats_mcache_inuse_bytes
-
Number of bytes in use by mcache structures
-
-
go_memstats_mcache_sys_bytes
-
Number of bytes used for mcache structures obtained from system
-
-
go_memstats_mspan_inuse_bytes
-
Number of bytes in use by mspan structures
-
-
go_memstats_mspan_sys_bytes
-
Number of bytes used for mspan structures obtained from system
-
-
go_memstats_next_gc_bytes
-
Number of heap bytes when next garbage collection will take place
-
-
go_memstats_other_sys_bytes
-
Number of bytes used for other system allocations
-
-
go_memstats_stack_inuse_bytes
-
Number of bytes in use by the stack allocator
-
-
go_memstats_stack_sys_bytes
-
Number of bytes obtained from system for stack allocator
-
-
go_memstats_sys_bytes
-
Number of bytes obtained from system
-
-
go_threads
-
Number of OS threads created
-
-
promhttp_metric_handler_requests_in_flight
-
Current number of scrapes being served
-
-
promhttp_metric_handler_requests_total
-
Total number of scrapes by HTTP status code
-
-
-
-
-
- -
- -
-

- - Building - - - - - Back to Top - - -

- -

As this project is built with Go, so you need to install that first. The installation of Go is out of the scope of this document, please follow the official documentation for Go. After the installation of the required tools you need to get the sources:

- -
git clone https://github.com/owncloud/ocis-hello.git
-cd ocis-hello
- -

All required tool besides Go itself and make are bundled or getting automatically installed within the GOPATH. All commands to build this project are part of our Makefile.

- -

Backend

- -
make generate
-make build
- -

The above commands will download a Phoenix release and embed it into the binary. Finally you should have the binary within the bin/ folder now, give it a try with ./bin/ocis-hello -h to see all available options.

- -
- -
-

- - License - - - - - Back to Top - - -

- - This project is licensed under the Apache 2.0 license. For the license of the used libraries you have to check the respective sources. -
- - - diff --git a/docs/public/index.xml b/docs/public/index.xml deleted file mode 100644 index 203e20499..000000000 --- a/docs/public/index.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - ownCloud Infinite Scale: Phoenix - https://owncloud.github.io/ocis-phoenix/ - Recent content on ownCloud Infinite Scale: Phoenix - Hugo -- gohugo.io - en-us - Wed, 02 May 2018 00:00:00 +0000 - - - - - - About - https://owncloud.github.io/ocis-phoenix/about/ - Wed, 02 May 2018 00:00:00 +0000 - - https://owncloud.github.io/ocis-phoenix/about/ - TBD - - - - Getting Started - https://owncloud.github.io/ocis-phoenix/getting-started/ - Wed, 02 May 2018 00:00:00 +0000 - - https://owncloud.github.io/ocis-phoenix/getting-started/ - Installation So far we are offering two different variants for the installation. You can choose between Docker or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it. -Docker TBD -Binaries TBD -Configuration We provide overall three different variants of configuration. The variant based on environment variables and commandline flags are split up into global values and command-specific values. - - - - Building - https://owncloud.github.io/ocis-phoenix/building/ - Wed, 02 May 2018 00:00:00 +0000 - - https://owncloud.github.io/ocis-phoenix/building/ - As this project is built with Go, so you need to install that first. The installation of Go is out of the scope of this document, please follow the official documentation for Go. After the installation of the required tools you need to get the sources: -git clone https://github.com/owncloud/ocis-hello.git cd ocis-hello All required tool besides Go itself and make are bundled or getting automatically installed within the GOPATH. All commands to build this project are part of our Makefile. - - - - License - https://owncloud.github.io/ocis-phoenix/license/ - Wed, 02 May 2018 00:00:00 +0000 - - https://owncloud.github.io/ocis-phoenix/license/ - This project is licensed under the Apache 2.0 license. For the license of the used libraries you have to check the respective sources. - - - - \ No newline at end of file diff --git a/docs/public/sitemap.xml b/docs/public/sitemap.xml deleted file mode 100644 index 3cf0d0ec6..000000000 --- a/docs/public/sitemap.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - https://owncloud.github.io/ocis-phoenix/about/ - 2018-05-02T00:00:00+00:00 - - - - https://owncloud.github.io/ocis-phoenix/getting-started/ - 2018-05-02T00:00:00+00:00 - - - - https://owncloud.github.io/ocis-phoenix/building/ - 2018-05-02T00:00:00+00:00 - - - - https://owncloud.github.io/ocis-phoenix/license/ - 2018-05-02T00:00:00+00:00 - - - - https://owncloud.github.io/ocis-phoenix/categories/ - 0 - - - - https://owncloud.github.io/ocis-phoenix/tags/ - 0 - - - - https://owncloud.github.io/ocis-phoenix/ - 2018-05-02T00:00:00+00:00 - 0 - - - \ No newline at end of file diff --git a/docs/public/syntax.css b/docs/public/syntax.css deleted file mode 100644 index 681758d06..000000000 --- a/docs/public/syntax.css +++ /dev/null @@ -1,59 +0,0 @@ -/* Background */ .chroma { color: #f8f8f2; background-color: #272822 } -/* Error */ .chroma .err { color: #960050; background-color: #1e0010 } -/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; } -/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; width: auto; overflow: auto; display: block; } -/* LineHighlight */ .chroma .hl { display: block; width: 100%;background-color: #ffffcc } -/* LineNumbersTable */ .chroma .lnt { margin-right: 0.4em; padding: 0 0.4em 0 0.4em; } -/* LineNumbers */ .chroma .ln { margin-right: 0.4em; padding: 0 0.4em 0 0.4em; } -/* Keyword */ .chroma .k { color: #66d9ef } -/* KeywordConstant */ .chroma .kc { color: #66d9ef } -/* KeywordDeclaration */ .chroma .kd { color: #66d9ef } -/* KeywordNamespace */ .chroma .kn { color: #f92672 } -/* KeywordPseudo */ .chroma .kp { color: #66d9ef } -/* KeywordReserved */ .chroma .kr { color: #66d9ef } -/* KeywordType */ .chroma .kt { color: #66d9ef } -/* NameAttribute */ .chroma .na { color: #a6e22e } -/* NameClass */ .chroma .nc { color: #a6e22e } -/* NameConstant */ .chroma .no { color: #66d9ef } -/* NameDecorator */ .chroma .nd { color: #a6e22e } -/* NameException */ .chroma .ne { color: #a6e22e } -/* NameFunction */ .chroma .nf { color: #a6e22e } -/* NameOther */ .chroma .nx { color: #a6e22e } -/* NameTag */ .chroma .nt { color: #f92672 } -/* Literal */ .chroma .l { color: #ae81ff } -/* LiteralDate */ .chroma .ld { color: #e6db74 } -/* LiteralString */ .chroma .s { color: #e6db74 } -/* LiteralStringAffix */ .chroma .sa { color: #e6db74 } -/* LiteralStringBacktick */ .chroma .sb { color: #e6db74 } -/* LiteralStringChar */ .chroma .sc { color: #e6db74 } -/* LiteralStringDelimiter */ .chroma .dl { color: #e6db74 } -/* LiteralStringDoc */ .chroma .sd { color: #e6db74 } -/* LiteralStringDouble */ .chroma .s2 { color: #e6db74 } -/* LiteralStringEscape */ .chroma .se { color: #ae81ff } -/* LiteralStringHeredoc */ .chroma .sh { color: #e6db74 } -/* LiteralStringInterpol */ .chroma .si { color: #e6db74 } -/* LiteralStringOther */ .chroma .sx { color: #e6db74 } -/* LiteralStringRegex */ .chroma .sr { color: #e6db74 } -/* LiteralStringSingle */ .chroma .s1 { color: #e6db74 } -/* LiteralStringSymbol */ .chroma .ss { color: #e6db74 } -/* LiteralNumber */ .chroma .m { color: #ae81ff } -/* LiteralNumberBin */ .chroma .mb { color: #ae81ff } -/* LiteralNumberFloat */ .chroma .mf { color: #ae81ff } -/* LiteralNumberHex */ .chroma .mh { color: #ae81ff } -/* LiteralNumberInteger */ .chroma .mi { color: #ae81ff } -/* LiteralNumberIntegerLong */ .chroma .il { color: #ae81ff } -/* LiteralNumberOct */ .chroma .mo { color: #ae81ff } -/* Operator */ .chroma .o { color: #f92672 } -/* OperatorWord */ .chroma .ow { color: #f92672 } -/* Comment */ .chroma .c { color: #75715e } -/* CommentHashbang */ .chroma .ch { color: #75715e } -/* CommentMultiline */ .chroma .cm { color: #75715e } -/* CommentSingle */ .chroma .c1 { color: #75715e } -/* CommentSpecial */ .chroma .cs { color: #75715e } -/* CommentPreproc */ .chroma .cp { color: #75715e } -/* CommentPreprocFile */ .chroma .cpf { color: #75715e } -/* GenericDeleted */ .chroma .gd { color: #f92672 } -/* GenericEmph */ .chroma .ge { font-style: italic } -/* GenericInserted */ .chroma .gi { color: #a6e22e } -/* GenericStrong */ .chroma .gs { font-weight: bold } -/* GenericSubheading */ .chroma .gu { color: #75715e } diff --git a/docs/public/tags/index.xml b/docs/public/tags/index.xml deleted file mode 100644 index b47874e22..000000000 --- a/docs/public/tags/index.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - Tags on ownCloud Infinite Scale: Phoenix - https://owncloud.github.io/ocis-phoenix/tags/ - Recent content in Tags on ownCloud Infinite Scale: Phoenix - Hugo -- gohugo.io - en-us - - - - - - \ No newline at end of file diff --git a/docs/static/styles.css b/docs/static/styles.css new file mode 100644 index 000000000..3eeea791f --- /dev/null +++ b/docs/static/styles.css @@ -0,0 +1,338 @@ +body, +html { + cursor: default; +} + +body, +div, +dl, +dt, +dd, +ul, +ol, +li, +h1, +h2, +h3, +h4, +h5, +h6, +pre, +form, +fieldset, +input, +textarea, +p, +blockquote, +th, +td { + margin: 0; + padding: 0; +} + +* { + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; +} + +:before, +:after { + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; +} + +img, +object, +embed { + max-width: 100%; + height: auto; +} + +object, +embed { + height: 100%; +} + +img { + margin: 1.25% 0; + -ms-interpolation-mode: bicubic; +} + +html { + background-color: #F0F1F3; + padding: 2%; +} + +body { + font-size: 16px; + line-height: 1.6; + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; + color: #242424; + max-width: 800px; + margin: 5% auto; +} + +body::after { + clear: both; + content: ""; + display: table; +} + +header { + margin-bottom: 8%; +} + +footer { + text-align: center; +} + +h1, +h2, +h3, +h4, +h5, +h2 a { + color: #263A48; + font-weight: 500; + text-decoration: none; +} + +h1, +h2 { + font-size: 36px; + padding-bottom: 0.3em; + margin-bottom: 0.4em; + border-bottom: 1px solid #eee +} + +h2 { + font-size: 22px; + padding-bottom: 0.6em; + margin-bottom: 0.6em; + margin-top: 2.5em; +} + +h3 { + font-size: 18px; + margin-bottom: 0.3em; +} + +h2 small a { + color: #98999C; + font-size: 15px; + font-weight: normal; + float: right; + position: absolute; + top: 15px; + right: 20px; +} + +section { + background: #fff; + margin-bottom: 1%; + position: relative; + padding: 6% 8%; +} + +blockquote { + border-left: 3px solid #d54e21; + font-size: 16px; + padding: 0 0 0 20px; + color: #d54e21; +} + +blockquote a { + color: #d54e21; + font-weight: 500; +} + +blockquote code { + color: #d54e21; +} + +.highlight pre { + padding: 10px; +} + +.highlight { + margin-bottom: 4%; +} + +a { + color: #1e8cbe; + text-decoration: underline; +} + +a:hover { + color: #d54e21; +} + +ul { + list-style: none; +} + +ol { + list-style: number; +} + +ol li { + color: #98999C; + margin-bottom: 5px; +} + +ol li:last-child { + margin-bottom: 0; +} + +p, +ul, +ol, +blockquote { + margin-bottom: 4%; +} + +ul ul { + padding-top: 0; + margin-bottom: 0; + margin-left: 4%; +} + +ul ul li:before { + content: '-'; + display: inline-block; + padding-right: 2%; +} + +ul.col-2 { + color: #98999C; + -webkit-column-count: 2; + -moz-column-count: 2; + column-count: 2; + -webkit-column-gap: 20px; + -moz-column-gap: 20px; + column-gap: 20px; +} + +dl dt { + font-weight: bold; +} + +dl dd { + padding-left: 10px; +} + +@media screen and (min-width: 500px) { + ul.col-2 { + -webkit-column-count: 3; + -moz-column-count: 3; + column-count: 3; + -webkit-column-gap: 20px; + -moz-column-gap: 20px; + column-gap: 20px; + } +} + +nav { + background: #F0F1F3; + min-width: 215px; + margin-bottom: 5px; + margin-top: 15px; +} + +nav:first-of-type a { + color: #d54e21; + border-radius: 0; +} + +nav:first-of-type a:hover { + color: #d54e21; +} + +nav:first-of-type a:before { + background-color: #d54e21; +} + +nav.affix { + position: fixed; + top: 20px; +} + +nav.affix-bottom { + position: absolute; +} + +nav a { + border-radius: 3px; + font-size: 15px; + display: block; + cursor: pointer; + font-weight: 500; + position: relative; + text-decoration: none; + padding: 10px 12px; + width: 100%; + padding-right: 3px; + border-bottom: 2px solid #fff; +} + +nav a:before { + content: ''; + width: 4px; + display: block; + left: 0; + position: absolute; + height: 100%; + display: none; + background: #1e8cbe; + top: 0; +} + +nav a:hover { + background-color: #E6E8EA; + color: #1e8cbe; + text-decoration: underline; +} + +nav a:hover:before { + display: block; +} + +nav a:last-of-type { + border-bottom: none; +} + +.gist { + margin-top: 5.1%; + margin-bottom: 5%; +} + +@media screen and (max-width: 1050px) { + body { + margin: 0 auto; + } +} + +@media screen and (max-width: 767px) { + header span { + display: none; + } + + h1 { + font-size: 26px; + } + + h2 { + font-size: 20px; + } +} + +@media screen and (max-width: 514px) { + p, + ul, + ol, + blockquote { + margin-bottom: 8%; + } +}