mirror of
https://github.com/cs3org/reva.git
synced 2025-04-18 13:44:12 +03:00
skip-ci: Fix documentation build system (#4641)
This commit is contained in:
Hugo Labrador
GitHub
parent
d715d4a4f6
commit
dd9ac6f99b
1
.gitignore
vendored
1
.gitignore
vendored
@ -58,3 +58,4 @@ toolchain/
|
||||
logs_test/
|
||||
|
||||
tmp/
|
||||
public/
|
||||
|
||||
15
docs/assets/scss/styles_project
Normal file
15
docs/assets/scss/styles_project
Normal file
@ -0,0 +1,15 @@
|
||||
/*
|
||||
|
||||
Add styles or override variables from the theme here.
|
||||
|
||||
*/
|
||||
|
||||
$primary: #29a7df;
|
||||
$secondary: #ED6A5A;
|
||||
$dark: #131516;
|
||||
$enable-gradients: false;
|
||||
$enable-rounded: false;
|
||||
$enable-shadows: false;
|
||||
$td-enable-google-fonts: true;
|
||||
$google_font_name: "Roboto";
|
||||
$google_font_family: "Roboto:300,300i,400,400i,700,700i";
|
||||
@ -11,4 +11,5 @@ To configure an GRPC interceptor you need to follow this convention in the confi
|
||||
{{< highlight toml >}}
|
||||
[grpc.interceptors.interceptor_name]
|
||||
... config ...
|
||||
{{</ highlight >}}
|
||||
|
||||
|
||||
@ -11,4 +11,4 @@ To configure a GRPC service you need to follow this convention in the config fil
|
||||
{{< highlight toml >}}
|
||||
[grpc.services.service_name]
|
||||
... config ...
|
||||
|
||||
{{</ highlight >}}
|
||||
|
||||
@ -11,4 +11,5 @@ To configure an HTTP middleware you need to follow this convention in the config
|
||||
{{< highlight toml >}}
|
||||
[http.middlewares.middleware_name]
|
||||
... config ...
|
||||
{{</ highlight >}}
|
||||
|
||||
|
||||
@ -11,4 +11,6 @@ To configure an HTTP service you need to follow this convention in the config fi
|
||||
{{< highlight toml >}}
|
||||
[http.services.service_name]
|
||||
... config ...
|
||||
{{</ highlight >}}
|
||||
|
||||
|
||||
|
||||
@ -32,11 +32,11 @@ nats_stream = "reva-notifications"
|
||||
{{< /highlight >}}
|
||||
{{% /dir %}}
|
||||
|
||||
{{% dir name="templates" type="map[string]interface{}" default= %}}
|
||||
{{% dir name="templates" type="map[string]interface{}" default=nil %}}
|
||||
Notification templates for the service. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/notification/notificationhelper/notificationhelper.go#L50)
|
||||
{{< highlight toml >}}
|
||||
[notification.notificationhelper]
|
||||
templates =
|
||||
templates = nil
|
||||
{{< /highlight >}}
|
||||
{{% /dir %}}
|
||||
|
||||
|
||||
@ -16,11 +16,11 @@ nats_address = ""
|
||||
{{< /highlight >}}
|
||||
{{% /dir %}}
|
||||
|
||||
{{% dir name="nats_token" type="string" default="The token to authenticate against the NATS server" %}}
|
||||
[[Ref]](https://github.com/cs3org/reva/tree/master/internal/serverless/services/notifications/notifications.go#L48)
|
||||
{{% dir name="nats_token" type="string" default="" %}}
|
||||
The token to authenticate against the NATS server [[Ref]](https://github.com/cs3org/reva/tree/master/internal/serverless/services/notifications/notifications.go#L48)
|
||||
{{< highlight toml >}}
|
||||
[serverless.services.notifications]
|
||||
nats_token = "The token to authenticate against the NATS server"
|
||||
nats_token = ""
|
||||
{{< /highlight >}}
|
||||
{{% /dir %}}
|
||||
|
||||
@ -32,11 +32,11 @@ nats_prefix = "reva-notifications"
|
||||
{{< /highlight >}}
|
||||
{{% /dir %}}
|
||||
|
||||
{{% dir name="handlers" type="map[string]map[string]interface{}" default= %}}
|
||||
{{% dir name="handlers" type="map[string]map[string]interface{}" default=nil %}}
|
||||
Settings for the different notification handlers. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/serverless/services/notifications/notifications.go#L50)
|
||||
{{< highlight toml >}}
|
||||
[serverless.services.notifications]
|
||||
handlers =
|
||||
handlers = nil
|
||||
{{< /highlight >}}
|
||||
{{% /dir %}}
|
||||
|
||||
|
||||
2031
docs/package-lock.json
generated
2031
docs/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@ -16,10 +16,12 @@
|
||||
"url": "https://github.com/bep/tech-doc-hugo/issues"
|
||||
},
|
||||
"homepage": "https://github.com/bep/tech-doc-hugo#readme",
|
||||
"dependencies": {},
|
||||
"devDependencies": {
|
||||
"autoprefixer": "^10.2.6",
|
||||
"postcss-cli": "^8.3.1",
|
||||
"postcss": "^8.4.31"
|
||||
"postcss": "^8.4.31",
|
||||
"postcss-cli": "^8.3.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"hugo-extended": "^0.124.1"
|
||||
}
|
||||
}
|
||||
|
||||
2
docs/themes/docsy
vendored
2
docs/themes/docsy
vendored
@ -1 +1 @@
|
||||
Subproject commit 1a09abe6d7eaf02e44f79de3eadf8178a3792e81
|
||||
Subproject commit b95a4948ee42e601d2685a334e0b2362e31820ef
|
||||
@ -45,9 +45,9 @@ import (
|
||||
|
||||
type config struct {
|
||||
NatsAddress string `docs:";The NATS server address." mapstructure:"nats_address"`
|
||||
NatsToken string `docs:"The token to authenticate against the NATS server" mapstructure:"nats_token"`
|
||||
NatsToken string `docs:";The token to authenticate against the NATS server" mapstructure:"nats_token"`
|
||||
NatsPrefix string `docs:"reva-notifications;The notifications NATS stream." mapstructure:"nats_prefix"`
|
||||
HandlerConf map[string]map[string]interface{} `docs:";Settings for the different notification handlers." mapstructure:"handlers"`
|
||||
HandlerConf map[string]map[string]interface{} `docs:"nil;Settings for the different notification handlers." mapstructure:"handlers"`
|
||||
GroupingInterval int `docs:"60;Time in seconds to group incoming notification triggers" mapstructure:"grouping_interval"`
|
||||
GroupingMaxSize int `docs:"100;Maximum number of notifications to group" mapstructure:"grouping_max_size"`
|
||||
StorageDriver string `docs:"mysql;The driver used to store notifications" mapstructure:"storage_driver"`
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
[build]
|
||||
publish = "docs/public"
|
||||
command = "git submodule update -f --init --recursive && cd docs/ && npm install postcss-cli && hugo --gc --minify"
|
||||
command = "git submodule update -f --init --recursive && cd docs/ && npm install postcss-cli && cd themes/docsy && npm run _mkdir:hugo-mod && cd ../../ && hugo --gc --minify"
|
||||
ignore = "git diff --quiet HEAD^ HEAD docs/"
|
||||
|
||||
[build.environment]
|
||||
HUGO_VERSION = "0.59.0"
|
||||
HUGO_VERSION = "0.124.1"
|
||||
HUGO_ENV = "production"
|
||||
|
||||
@ -47,7 +47,7 @@ type Config struct {
|
||||
NatsAddress string `docs:";The NATS server address." mapstructure:"nats_address"`
|
||||
NatsToken string `docs:";The token to authenticate against the NATS server" mapstructure:"nats_token"`
|
||||
NatsStream string `docs:"reva-notifications;The notifications NATS stream." mapstructure:"nats_stream"`
|
||||
Templates map[string]interface{} `docs:";Notification templates for the service." mapstructure:"templates"`
|
||||
Templates map[string]interface{} `docs:"nil;Notification templates for the service." mapstructure:"templates"`
|
||||
}
|
||||
|
||||
func defaultConfig() *Config {
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user