From 418ec35778c4d2735131addc7614d6a8a0af35c2 Mon Sep 17 00:00:00 2001 From: Alexey Igrychev Date: Mon, 7 Feb 2022 21:19:43 +0000 Subject: [PATCH 01/16] site: move reference to documentation (cli, api) Signed-off-by: Alexey Igrychev --- client/cmd/trdl/command/md_docs.go | 12 ++--- client/cmd/trdl/docs.go | 4 +- docs/Makefile | 2 +- docs/_data/sidebars/_cli.yml | 20 ++++---- docs/_data/sidebars/_vault_plugin.yml | 26 +++++------ docs/_data/sidebars/reference.yml | 46 +++++++++---------- .../{ => documentation}/reference/cli/trdl.md | 0 .../reference/cli/trdl.short.md | 0 .../reference/cli/trdl_.md | 0 .../reference/cli/trdl_.short.md | 0 .../reference/cli/trdl_add.md | 0 .../reference/cli/trdl_add.short.md | 0 .../reference/cli/trdl_bin_path.md | 0 .../reference/cli/trdl_bin_path.short.md | 0 .../reference/cli/trdl_dir_path.md | 0 .../reference/cli/trdl_dir_path.short.md | 0 .../reference/cli/trdl_docs.md | 0 .../reference/cli/trdl_docs.short.md | 0 .../reference/cli/trdl_exec.md | 0 .../reference/cli/trdl_exec.short.md | 0 .../reference/cli/trdl_list.md | 0 .../reference/cli/trdl_list.short.md | 0 .../reference/cli/trdl_remove.md | 0 .../reference/cli/trdl_remove.short.md | 0 .../reference/cli/trdl_set_default_channel.md | 0 .../cli/trdl_set_default_channel.short.md | 0 .../reference/cli/trdl_update.md | 0 .../reference/cli/trdl_update.short.md | 0 .../reference/cli/trdl_use.md | 0 .../reference/cli/trdl_use.short.md | 0 .../reference/cli/trdl_version.md | 0 .../reference/cli/trdl_version.short.md | 0 .../reference/vault_plugin/configure.md | 0 .../vault_plugin/configure/git_credential.md | 0 .../vault_plugin/configure/pgp_signing_key.md | 0 .../configure/trusted_pgp_public_key.md | 0 .../configure/trusted_pgp_public_key/name.md | 0 .../reference/vault_plugin/index.md | 27 +++++++++++ .../reference/vault_plugin/publish.md | 0 .../reference/vault_plugin/release.md | 0 .../reference/vault_plugin/task.md | 0 .../reference/vault_plugin/task/configure.md | 0 .../reference/vault_plugin/task/uuid.md | 0 .../vault_plugin/task/uuid/cancel.md | 0 .../reference/vault_plugin/task/uuid/log.md | 0 .../_includes/reference/vault_plugin/index.md | 27 ----------- docs/pages_en/QUICKSTART.md | 8 ++-- .../documentation/reference/cli/overview.md | 20 ++++++++ .../documentation/reference/cli/trdl_add.md | 6 +++ .../reference/cli/trdl_bin_path.md | 6 +++ .../reference/cli/trdl_dir_path.md | 6 +++ .../documentation/reference/cli/trdl_exec.md | 6 +++ .../documentation/reference/cli/trdl_list.md | 6 +++ .../reference/cli/trdl_remove.md | 6 +++ .../reference/cli/trdl_set_default_channel.md | 6 +++ .../reference/cli/trdl_update.md | 6 +++ .../documentation/reference/cli/trdl_use.md | 6 +++ .../reference/vault_plugin/configure.md | 6 +++ .../vault_plugin/configure/git_credential.md | 6 +++ .../vault_plugin/configure/pgp_signing_key.md | 6 +++ .../configure/trusted_pgp_public_key.md | 6 +++ .../configure/trusted_pgp_public_key/name.md | 6 +++ .../reference/vault_plugin/index.md | 6 +++ .../reference/vault_plugin/publish.md | 6 +++ .../reference/vault_plugin/release.md | 6 +++ .../reference/vault_plugin/task.md | 6 +++ .../reference/vault_plugin/task/configure.md | 6 +++ .../reference/vault_plugin/task/uuid.md | 6 +++ .../vault_plugin/task/uuid/cancel.md | 6 +++ .../reference/vault_plugin/task/uuid/log.md | 6 +++ docs/pages_en/reference/cli/overview.md | 20 -------- docs/pages_en/reference/cli/trdl_add.md | 6 --- docs/pages_en/reference/cli/trdl_bin_path.md | 6 --- docs/pages_en/reference/cli/trdl_dir_path.md | 6 --- docs/pages_en/reference/cli/trdl_exec.md | 6 --- docs/pages_en/reference/cli/trdl_list.md | 6 --- docs/pages_en/reference/cli/trdl_remove.md | 6 --- .../reference/cli/trdl_set_default_channel.md | 6 --- docs/pages_en/reference/cli/trdl_update.md | 6 --- docs/pages_en/reference/cli/trdl_use.md | 6 --- docs/pages_en/reference/trdl_yaml.md | 2 +- .../reference/vault_plugin/configure.md | 6 --- .../vault_plugin/configure/git_credential.md | 6 --- .../vault_plugin/configure/pgp_signing_key.md | 6 --- .../configure/trusted_pgp_public_key.md | 6 --- .../configure/trusted_pgp_public_key/name.md | 6 --- docs/pages_en/reference/vault_plugin/index.md | 6 --- .../reference/vault_plugin/publish.md | 6 --- .../reference/vault_plugin/release.md | 6 --- docs/pages_en/reference/vault_plugin/task.md | 6 --- .../reference/vault_plugin/task/configure.md | 6 --- .../reference/vault_plugin/task/uuid.md | 6 --- .../vault_plugin/task/uuid/cancel.md | 6 --- .../reference/vault_plugin/task/uuid/log.md | 6 --- docs/pages_ru/QUICKSTART.md | 8 ++-- docs/pages_ru/documentation/reference/cli | 1 + .../documentation/reference/vault_plugin | 1 + docs/pages_ru/reference/cli | 1 - docs/pages_ru/reference/trdl_yaml.md | 2 +- docs/pages_ru/reference/vault_plugin | 1 - 100 files changed, 246 insertions(+), 246 deletions(-) rename docs/_includes/{ => documentation}/reference/cli/trdl.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl.short.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_.short.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_add.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_add.short.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_bin_path.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_bin_path.short.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_dir_path.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_dir_path.short.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_docs.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_docs.short.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_exec.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_exec.short.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_list.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_list.short.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_remove.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_remove.short.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_set_default_channel.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_set_default_channel.short.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_update.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_update.short.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_use.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_use.short.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_version.md (100%) rename docs/_includes/{ => documentation}/reference/cli/trdl_version.short.md (100%) rename docs/_includes/{ => documentation}/reference/vault_plugin/configure.md (100%) rename docs/_includes/{ => documentation}/reference/vault_plugin/configure/git_credential.md (100%) rename docs/_includes/{ => documentation}/reference/vault_plugin/configure/pgp_signing_key.md (100%) rename docs/_includes/{ => documentation}/reference/vault_plugin/configure/trusted_pgp_public_key.md (100%) rename docs/_includes/{ => documentation}/reference/vault_plugin/configure/trusted_pgp_public_key/name.md (100%) create mode 100644 docs/_includes/documentation/reference/vault_plugin/index.md rename docs/_includes/{ => documentation}/reference/vault_plugin/publish.md (100%) rename docs/_includes/{ => documentation}/reference/vault_plugin/release.md (100%) rename docs/_includes/{ => documentation}/reference/vault_plugin/task.md (100%) rename docs/_includes/{ => documentation}/reference/vault_plugin/task/configure.md (100%) rename docs/_includes/{ => documentation}/reference/vault_plugin/task/uuid.md (100%) rename docs/_includes/{ => documentation}/reference/vault_plugin/task/uuid/cancel.md (100%) rename docs/_includes/{ => documentation}/reference/vault_plugin/task/uuid/log.md (100%) delete mode 100644 docs/_includes/reference/vault_plugin/index.md create mode 100644 docs/pages_en/documentation/reference/cli/overview.md create mode 100644 docs/pages_en/documentation/reference/cli/trdl_add.md create mode 100644 docs/pages_en/documentation/reference/cli/trdl_bin_path.md create mode 100644 docs/pages_en/documentation/reference/cli/trdl_dir_path.md create mode 100644 docs/pages_en/documentation/reference/cli/trdl_exec.md create mode 100644 docs/pages_en/documentation/reference/cli/trdl_list.md create mode 100644 docs/pages_en/documentation/reference/cli/trdl_remove.md create mode 100644 docs/pages_en/documentation/reference/cli/trdl_set_default_channel.md create mode 100644 docs/pages_en/documentation/reference/cli/trdl_update.md create mode 100644 docs/pages_en/documentation/reference/cli/trdl_use.md create mode 100644 docs/pages_en/documentation/reference/vault_plugin/configure.md create mode 100644 docs/pages_en/documentation/reference/vault_plugin/configure/git_credential.md create mode 100644 docs/pages_en/documentation/reference/vault_plugin/configure/pgp_signing_key.md create mode 100644 docs/pages_en/documentation/reference/vault_plugin/configure/trusted_pgp_public_key.md create mode 100644 docs/pages_en/documentation/reference/vault_plugin/configure/trusted_pgp_public_key/name.md create mode 100644 docs/pages_en/documentation/reference/vault_plugin/index.md create mode 100644 docs/pages_en/documentation/reference/vault_plugin/publish.md create mode 100644 docs/pages_en/documentation/reference/vault_plugin/release.md create mode 100644 docs/pages_en/documentation/reference/vault_plugin/task.md create mode 100644 docs/pages_en/documentation/reference/vault_plugin/task/configure.md create mode 100644 docs/pages_en/documentation/reference/vault_plugin/task/uuid.md create mode 100644 docs/pages_en/documentation/reference/vault_plugin/task/uuid/cancel.md create mode 100644 docs/pages_en/documentation/reference/vault_plugin/task/uuid/log.md delete mode 100644 docs/pages_en/reference/cli/overview.md delete mode 100644 docs/pages_en/reference/cli/trdl_add.md delete mode 100644 docs/pages_en/reference/cli/trdl_bin_path.md delete mode 100644 docs/pages_en/reference/cli/trdl_dir_path.md delete mode 100644 docs/pages_en/reference/cli/trdl_exec.md delete mode 100644 docs/pages_en/reference/cli/trdl_list.md delete mode 100644 docs/pages_en/reference/cli/trdl_remove.md delete mode 100644 docs/pages_en/reference/cli/trdl_set_default_channel.md delete mode 100644 docs/pages_en/reference/cli/trdl_update.md delete mode 100644 docs/pages_en/reference/cli/trdl_use.md delete mode 100644 docs/pages_en/reference/vault_plugin/configure.md delete mode 100644 docs/pages_en/reference/vault_plugin/configure/git_credential.md delete mode 100644 docs/pages_en/reference/vault_plugin/configure/pgp_signing_key.md delete mode 100644 docs/pages_en/reference/vault_plugin/configure/trusted_pgp_public_key.md delete mode 100644 docs/pages_en/reference/vault_plugin/configure/trusted_pgp_public_key/name.md delete mode 100644 docs/pages_en/reference/vault_plugin/index.md delete mode 100644 docs/pages_en/reference/vault_plugin/publish.md delete mode 100644 docs/pages_en/reference/vault_plugin/release.md delete mode 100644 docs/pages_en/reference/vault_plugin/task.md delete mode 100644 docs/pages_en/reference/vault_plugin/task/configure.md delete mode 100644 docs/pages_en/reference/vault_plugin/task/uuid.md delete mode 100644 docs/pages_en/reference/vault_plugin/task/uuid/cancel.md delete mode 100644 docs/pages_en/reference/vault_plugin/task/uuid/log.md create mode 120000 docs/pages_ru/documentation/reference/cli create mode 120000 docs/pages_ru/documentation/reference/vault_plugin delete mode 120000 docs/pages_ru/reference/cli delete mode 120000 docs/pages_ru/reference/vault_plugin diff --git a/client/cmd/trdl/command/md_docs.go b/client/cmd/trdl/command/md_docs.go index d981578a..b95cf122 100644 --- a/client/cmd/trdl/command/md_docs.go +++ b/client/cmd/trdl/command/md_docs.go @@ -113,10 +113,10 @@ func genCliPages(cmd *cobra.Command, pagesDir string) error { fullCommandName := fullCommandFilesystemPath(cmd.CommandPath()) cmdPage := fmt.Sprintf(`--- title: %s -permalink: reference/cli/%s.html +permalink: documentation/reference/cli/%s.html --- -{%% include /reference/cli/%s.md %%} +{%% include documentation/reference/cli/%s.md %%} `, cmd.CommandPath(), fullCommandName, fullCommandName) path := filepath.Join(pagesDir, fmt.Sprintf("%s.md", fullCommandName)) @@ -145,7 +145,7 @@ func GenCliSidebar(cmdGroups Groups, sidebarPath string) error { cli: &cli - title: Overview - url: /reference/cli/overview.html + url: /documentation/reference/cli/overview.html `) for _, group := range cmdGroups { @@ -185,7 +185,7 @@ func genCliSidebar(cmd *cobra.Command, indent int, buf *bytes.Buffer) error { commandRecord := fmt.Sprintf(` %[1]s- title: %[2]s -%[1]s url: /reference/cli/%[3]s.html +%[1]s url: /documentation/reference/cli/%[3]s.html `, strings.Repeat(" ", indent), cmd.CommandPath(), fullCommandName) _, err := buf.WriteString(commandRecord) @@ -221,7 +221,7 @@ func genCliSidebar(cmd *cobra.Command, indent int, buf *bytes.Buffer) error { func GenCliOverview(cmdGroups Groups, pagesDir string) error { indexPage := `--- title: Overview -permalink: reference/cli/overview.html +permalink: documentation/reference/cli/overview.html toc: false --- @@ -247,7 +247,7 @@ toc: false fullCommandName = fullCommandFilesystemPath(cmd.Commands()[0].CommandPath()) } - indexPage += fmt.Sprintf(" - [trdl %s]({{ \"/reference/cli/%s.html\" | true_relative_url }}) — {%% include /reference/cli/%s.short.md %%}.\n", cmd.Name(), fullCommandName, fullCommandName) + indexPage += fmt.Sprintf(" - [trdl %s]({{ \"/documentation/reference/cli/%s.html\" | true_relative_url }}) — {%% include /documentation/reference/cli/%s.short.md %%}.\n", cmd.Name(), fullCommandName, fullCommandName) } doNewline = true diff --git a/client/cmd/trdl/docs.go b/client/cmd/trdl/docs.go index 055f68a3..24976540 100644 --- a/client/cmd/trdl/docs.go +++ b/client/cmd/trdl/docs.go @@ -24,8 +24,8 @@ func docsCmd(commandGroups *command.Groups) *cobra.Command { jekyllSiteDir := args[0] - partialsDir := filepath.Join(jekyllSiteDir, "_includes/reference/cli") - pagesDir := filepath.Join(jekyllSiteDir, "pages_en/reference/cli") + partialsDir := filepath.Join(jekyllSiteDir, "_includes/documentation/reference/cli") + pagesDir := filepath.Join(jekyllSiteDir, "pages_en/documentation/reference/cli") sidebarPath := filepath.Join(jekyllSiteDir, "_data/sidebars/_cli.yml") for _, path := range []string{partialsDir, pagesDir} { diff --git a/docs/Makefile b/docs/Makefile index c1ad11df..d02bd649 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -10,7 +10,7 @@ _regen_reference_cli: _regen_reference_vault_plugin: @cd ../server && go install github.com/werf/trdl/server/cmd/vault-plugin-docs - @vault-plugin-docs generate-jekyll --base-pages-url /reference/vault_plugin --includes-dir _includes/reference/vault_plugin --pages-dir pages_en/reference/vault_plugin --sidebar-yml-path _data/sidebars/_vault_plugin.yml + @vault-plugin-docs generate-jekyll --base-pages-url /documentation/reference/vault_plugin --includes-dir _includes/documentation/reference/vault_plugin --pages-dir pages_en/documentation/reference/vault_plugin --sidebar-yml-path _data/sidebars/_vault_plugin.yml _compile: @( \ diff --git a/docs/_data/sidebars/_cli.yml b/docs/_data/sidebars/_cli.yml index d910cf24..27c6f77d 100644 --- a/docs/_data/sidebars/_cli.yml +++ b/docs/_data/sidebars/_cli.yml @@ -4,40 +4,40 @@ cli: &cli - title: Overview - url: /reference/cli/overview.html + url: /documentation/reference/cli/overview.html - title: Configuration commands f: - title: trdl add - url: /reference/cli/trdl_add.html + url: /documentation/reference/cli/trdl_add.html - title: trdl remove - url: /reference/cli/trdl_remove.html + url: /documentation/reference/cli/trdl_remove.html - title: trdl list - url: /reference/cli/trdl_list.html + url: /documentation/reference/cli/trdl_list.html - title: trdl set-default-channel - url: /reference/cli/trdl_set_default_channel.html + url: /documentation/reference/cli/trdl_set_default_channel.html - title: Main commands f: - title: trdl use - url: /reference/cli/trdl_use.html + url: /documentation/reference/cli/trdl_use.html - title: Advanced commands f: - title: trdl update - url: /reference/cli/trdl_update.html + url: /documentation/reference/cli/trdl_update.html - title: trdl exec - url: /reference/cli/trdl_exec.html + url: /documentation/reference/cli/trdl_exec.html - title: trdl dir-path - url: /reference/cli/trdl_dir_path.html + url: /documentation/reference/cli/trdl_dir_path.html - title: trdl bin-path - url: /reference/cli/trdl_bin_path.html + url: /documentation/reference/cli/trdl_bin_path.html diff --git a/docs/_data/sidebars/_vault_plugin.yml b/docs/_data/sidebars/_vault_plugin.yml index e01efa22..96eeca98 100644 --- a/docs/_data/sidebars/_vault_plugin.yml +++ b/docs/_data/sidebars/_vault_plugin.yml @@ -3,30 +3,30 @@ _vault_plugin: &_vault_plugin - title: Overview - url: /reference/vault_plugin/index.html + url: /documentation/reference/vault_plugin/index.html - title: Paths f: - title: /configure - url: /reference/vault_plugin/configure.html + url: /documentation/reference/vault_plugin/configure.html - title: /configure/git_credential - url: /reference/vault_plugin/configure/git_credential.html + url: /documentation/reference/vault_plugin/configure/git_credential.html - title: /configure/pgp_signing_key - url: /reference/vault_plugin/configure/pgp_signing_key.html + url: /documentation/reference/vault_plugin/configure/pgp_signing_key.html - title: /configure/trusted_pgp_public_key - url: /reference/vault_plugin/configure/trusted_pgp_public_key.html + url: /documentation/reference/vault_plugin/configure/trusted_pgp_public_key.html - title: /configure/trusted_pgp_public_key/:name - url: /reference/vault_plugin/configure/trusted_pgp_public_key/name.html + url: /documentation/reference/vault_plugin/configure/trusted_pgp_public_key/name.html - title: /publish - url: /reference/vault_plugin/publish.html + url: /documentation/reference/vault_plugin/publish.html - title: /release - url: /reference/vault_plugin/release.html + url: /documentation/reference/vault_plugin/release.html - title: /task - url: /reference/vault_plugin/task.html + url: /documentation/reference/vault_plugin/task.html - title: /task/configure - url: /reference/vault_plugin/task/configure.html + url: /documentation/reference/vault_plugin/task/configure.html - title: /task/:uuid - url: /reference/vault_plugin/task/uuid.html + url: /documentation/reference/vault_plugin/task/uuid.html - title: /task/:uuid/cancel - url: /reference/vault_plugin/task/uuid/cancel.html + url: /documentation/reference/vault_plugin/task/uuid/cancel.html - title: /task/:uuid/log - url: /reference/vault_plugin/task/uuid/log.html + url: /documentation/reference/vault_plugin/task/uuid/log.html diff --git a/docs/_data/sidebars/reference.yml b/docs/_data/sidebars/reference.yml index e4a35081..564bddd2 100644 --- a/docs/_data/sidebars/reference.yml +++ b/docs/_data/sidebars/reference.yml @@ -9,76 +9,76 @@ cli: &cli - title: Overview - url: /reference/cli/overview.html + url: /documentation/reference/cli/overview.html - title: Configuration commands f: - title: trdl add - url: /reference/cli/trdl_add.html + url: /documentation/reference/cli/trdl_add.html - title: trdl remove - url: /reference/cli/trdl_remove.html + url: /documentation/reference/cli/trdl_remove.html - title: trdl list - url: /reference/cli/trdl_list.html + url: /documentation/reference/cli/trdl_list.html - title: trdl set-default-channel - url: /reference/cli/trdl_set_default_channel.html + url: /documentation/reference/cli/trdl_set_default_channel.html - title: Main commands f: - title: trdl use - url: /reference/cli/trdl_use.html + url: /documentation/reference/cli/trdl_use.html - title: Advanced commands f: - title: trdl update - url: /reference/cli/trdl_update.html + url: /documentation/reference/cli/trdl_update.html - title: trdl exec - url: /reference/cli/trdl_exec.html + url: /documentation/reference/cli/trdl_exec.html - title: trdl dir-path - url: /reference/cli/trdl_dir_path.html + url: /documentation/reference/cli/trdl_dir_path.html - title: trdl bin-path - url: /reference/cli/trdl_bin_path.html + url: /documentation/reference/cli/trdl_bin_path.html # This file is generated by the github.com/werf/trdl/server/pkg/gendocs # DO NOT EDIT! _vault_plugin: &_vault_plugin - title: Overview - url: /reference/vault_plugin/index.html + url: /documentation/reference/vault_plugin/index.html - title: Paths f: - title: /configure - url: /reference/vault_plugin/configure.html + url: /documentation/reference/vault_plugin/configure.html - title: /configure/git_credential - url: /reference/vault_plugin/configure/git_credential.html + url: /documentation/reference/vault_plugin/configure/git_credential.html - title: /configure/pgp_signing_key - url: /reference/vault_plugin/configure/pgp_signing_key.html + url: /documentation/reference/vault_plugin/configure/pgp_signing_key.html - title: /configure/trusted_pgp_public_key - url: /reference/vault_plugin/configure/trusted_pgp_public_key.html + url: /documentation/reference/vault_plugin/configure/trusted_pgp_public_key.html - title: /configure/trusted_pgp_public_key/:name - url: /reference/vault_plugin/configure/trusted_pgp_public_key/name.html + url: /documentation/reference/vault_plugin/configure/trusted_pgp_public_key/name.html - title: /publish - url: /reference/vault_plugin/publish.html + url: /documentation/reference/vault_plugin/publish.html - title: /release - url: /reference/vault_plugin/release.html + url: /documentation/reference/vault_plugin/release.html - title: /task - url: /reference/vault_plugin/task.html + url: /documentation/reference/vault_plugin/task.html - title: /task/configure - url: /reference/vault_plugin/task/configure.html + url: /documentation/reference/vault_plugin/task/configure.html - title: /task/:uuid - url: /reference/vault_plugin/task/uuid.html + url: /documentation/reference/vault_plugin/task/uuid.html - title: /task/:uuid/cancel - url: /reference/vault_plugin/task/uuid/cancel.html + url: /documentation/reference/vault_plugin/task/uuid/cancel.html - title: /task/:uuid/log - url: /reference/vault_plugin/task/uuid/log.html + url: /documentation/reference/vault_plugin/task/uuid/log.html entries: en: diff --git a/docs/_includes/reference/cli/trdl.md b/docs/_includes/documentation/reference/cli/trdl.md similarity index 100% rename from docs/_includes/reference/cli/trdl.md rename to docs/_includes/documentation/reference/cli/trdl.md diff --git a/docs/_includes/reference/cli/trdl.short.md b/docs/_includes/documentation/reference/cli/trdl.short.md similarity index 100% rename from docs/_includes/reference/cli/trdl.short.md rename to docs/_includes/documentation/reference/cli/trdl.short.md diff --git a/docs/_includes/reference/cli/trdl_.md b/docs/_includes/documentation/reference/cli/trdl_.md similarity index 100% rename from docs/_includes/reference/cli/trdl_.md rename to docs/_includes/documentation/reference/cli/trdl_.md diff --git a/docs/_includes/reference/cli/trdl_.short.md b/docs/_includes/documentation/reference/cli/trdl_.short.md similarity index 100% rename from docs/_includes/reference/cli/trdl_.short.md rename to docs/_includes/documentation/reference/cli/trdl_.short.md diff --git a/docs/_includes/reference/cli/trdl_add.md b/docs/_includes/documentation/reference/cli/trdl_add.md similarity index 100% rename from docs/_includes/reference/cli/trdl_add.md rename to docs/_includes/documentation/reference/cli/trdl_add.md diff --git a/docs/_includes/reference/cli/trdl_add.short.md b/docs/_includes/documentation/reference/cli/trdl_add.short.md similarity index 100% rename from docs/_includes/reference/cli/trdl_add.short.md rename to docs/_includes/documentation/reference/cli/trdl_add.short.md diff --git a/docs/_includes/reference/cli/trdl_bin_path.md b/docs/_includes/documentation/reference/cli/trdl_bin_path.md similarity index 100% rename from docs/_includes/reference/cli/trdl_bin_path.md rename to docs/_includes/documentation/reference/cli/trdl_bin_path.md diff --git a/docs/_includes/reference/cli/trdl_bin_path.short.md b/docs/_includes/documentation/reference/cli/trdl_bin_path.short.md similarity index 100% rename from docs/_includes/reference/cli/trdl_bin_path.short.md rename to docs/_includes/documentation/reference/cli/trdl_bin_path.short.md diff --git a/docs/_includes/reference/cli/trdl_dir_path.md b/docs/_includes/documentation/reference/cli/trdl_dir_path.md similarity index 100% rename from docs/_includes/reference/cli/trdl_dir_path.md rename to docs/_includes/documentation/reference/cli/trdl_dir_path.md diff --git a/docs/_includes/reference/cli/trdl_dir_path.short.md b/docs/_includes/documentation/reference/cli/trdl_dir_path.short.md similarity index 100% rename from docs/_includes/reference/cli/trdl_dir_path.short.md rename to docs/_includes/documentation/reference/cli/trdl_dir_path.short.md diff --git a/docs/_includes/reference/cli/trdl_docs.md b/docs/_includes/documentation/reference/cli/trdl_docs.md similarity index 100% rename from docs/_includes/reference/cli/trdl_docs.md rename to docs/_includes/documentation/reference/cli/trdl_docs.md diff --git a/docs/_includes/reference/cli/trdl_docs.short.md b/docs/_includes/documentation/reference/cli/trdl_docs.short.md similarity index 100% rename from docs/_includes/reference/cli/trdl_docs.short.md rename to docs/_includes/documentation/reference/cli/trdl_docs.short.md diff --git a/docs/_includes/reference/cli/trdl_exec.md b/docs/_includes/documentation/reference/cli/trdl_exec.md similarity index 100% rename from docs/_includes/reference/cli/trdl_exec.md rename to docs/_includes/documentation/reference/cli/trdl_exec.md diff --git a/docs/_includes/reference/cli/trdl_exec.short.md b/docs/_includes/documentation/reference/cli/trdl_exec.short.md similarity index 100% rename from docs/_includes/reference/cli/trdl_exec.short.md rename to docs/_includes/documentation/reference/cli/trdl_exec.short.md diff --git a/docs/_includes/reference/cli/trdl_list.md b/docs/_includes/documentation/reference/cli/trdl_list.md similarity index 100% rename from docs/_includes/reference/cli/trdl_list.md rename to docs/_includes/documentation/reference/cli/trdl_list.md diff --git a/docs/_includes/reference/cli/trdl_list.short.md b/docs/_includes/documentation/reference/cli/trdl_list.short.md similarity index 100% rename from docs/_includes/reference/cli/trdl_list.short.md rename to docs/_includes/documentation/reference/cli/trdl_list.short.md diff --git a/docs/_includes/reference/cli/trdl_remove.md b/docs/_includes/documentation/reference/cli/trdl_remove.md similarity index 100% rename from docs/_includes/reference/cli/trdl_remove.md rename to docs/_includes/documentation/reference/cli/trdl_remove.md diff --git a/docs/_includes/reference/cli/trdl_remove.short.md b/docs/_includes/documentation/reference/cli/trdl_remove.short.md similarity index 100% rename from docs/_includes/reference/cli/trdl_remove.short.md rename to docs/_includes/documentation/reference/cli/trdl_remove.short.md diff --git a/docs/_includes/reference/cli/trdl_set_default_channel.md b/docs/_includes/documentation/reference/cli/trdl_set_default_channel.md similarity index 100% rename from docs/_includes/reference/cli/trdl_set_default_channel.md rename to docs/_includes/documentation/reference/cli/trdl_set_default_channel.md diff --git a/docs/_includes/reference/cli/trdl_set_default_channel.short.md b/docs/_includes/documentation/reference/cli/trdl_set_default_channel.short.md similarity index 100% rename from docs/_includes/reference/cli/trdl_set_default_channel.short.md rename to docs/_includes/documentation/reference/cli/trdl_set_default_channel.short.md diff --git a/docs/_includes/reference/cli/trdl_update.md b/docs/_includes/documentation/reference/cli/trdl_update.md similarity index 100% rename from docs/_includes/reference/cli/trdl_update.md rename to docs/_includes/documentation/reference/cli/trdl_update.md diff --git a/docs/_includes/reference/cli/trdl_update.short.md b/docs/_includes/documentation/reference/cli/trdl_update.short.md similarity index 100% rename from docs/_includes/reference/cli/trdl_update.short.md rename to docs/_includes/documentation/reference/cli/trdl_update.short.md diff --git a/docs/_includes/reference/cli/trdl_use.md b/docs/_includes/documentation/reference/cli/trdl_use.md similarity index 100% rename from docs/_includes/reference/cli/trdl_use.md rename to docs/_includes/documentation/reference/cli/trdl_use.md diff --git a/docs/_includes/reference/cli/trdl_use.short.md b/docs/_includes/documentation/reference/cli/trdl_use.short.md similarity index 100% rename from docs/_includes/reference/cli/trdl_use.short.md rename to docs/_includes/documentation/reference/cli/trdl_use.short.md diff --git a/docs/_includes/reference/cli/trdl_version.md b/docs/_includes/documentation/reference/cli/trdl_version.md similarity index 100% rename from docs/_includes/reference/cli/trdl_version.md rename to docs/_includes/documentation/reference/cli/trdl_version.md diff --git a/docs/_includes/reference/cli/trdl_version.short.md b/docs/_includes/documentation/reference/cli/trdl_version.short.md similarity index 100% rename from docs/_includes/reference/cli/trdl_version.short.md rename to docs/_includes/documentation/reference/cli/trdl_version.short.md diff --git a/docs/_includes/reference/vault_plugin/configure.md b/docs/_includes/documentation/reference/vault_plugin/configure.md similarity index 100% rename from docs/_includes/reference/vault_plugin/configure.md rename to docs/_includes/documentation/reference/vault_plugin/configure.md diff --git a/docs/_includes/reference/vault_plugin/configure/git_credential.md b/docs/_includes/documentation/reference/vault_plugin/configure/git_credential.md similarity index 100% rename from docs/_includes/reference/vault_plugin/configure/git_credential.md rename to docs/_includes/documentation/reference/vault_plugin/configure/git_credential.md diff --git a/docs/_includes/reference/vault_plugin/configure/pgp_signing_key.md b/docs/_includes/documentation/reference/vault_plugin/configure/pgp_signing_key.md similarity index 100% rename from docs/_includes/reference/vault_plugin/configure/pgp_signing_key.md rename to docs/_includes/documentation/reference/vault_plugin/configure/pgp_signing_key.md diff --git a/docs/_includes/reference/vault_plugin/configure/trusted_pgp_public_key.md b/docs/_includes/documentation/reference/vault_plugin/configure/trusted_pgp_public_key.md similarity index 100% rename from docs/_includes/reference/vault_plugin/configure/trusted_pgp_public_key.md rename to docs/_includes/documentation/reference/vault_plugin/configure/trusted_pgp_public_key.md diff --git a/docs/_includes/reference/vault_plugin/configure/trusted_pgp_public_key/name.md b/docs/_includes/documentation/reference/vault_plugin/configure/trusted_pgp_public_key/name.md similarity index 100% rename from docs/_includes/reference/vault_plugin/configure/trusted_pgp_public_key/name.md rename to docs/_includes/documentation/reference/vault_plugin/configure/trusted_pgp_public_key/name.md diff --git a/docs/_includes/documentation/reference/vault_plugin/index.md b/docs/_includes/documentation/reference/vault_plugin/index.md new file mode 100644 index 00000000..c6e79568 --- /dev/null +++ b/docs/_includes/documentation/reference/vault_plugin/index.md @@ -0,0 +1,27 @@ +The trdl plugin builds and releases software versions, publishes the release channels, and ensures object storage security via saving data signed by keys (no one has access to those keys) and continuously rotating TUF keys and metadata. + +## Paths + +* [`/configure`]({{ "/documentation/reference/vault_plugin/configure.html" | true_relative_url }}) — configure the plugin. + +* [`/configure/git_credential`]({{ "/documentation/reference/vault_plugin/configure/git_credential.html" | true_relative_url }}) — configure git credentials. + +* [`/configure/pgp_signing_key`]({{ "/documentation/reference/vault_plugin/configure/pgp_signing_key.html" | true_relative_url }}) — configure a pgp key for signing release artifacts. + +* [`/configure/trusted_pgp_public_key`]({{ "/documentation/reference/vault_plugin/configure/trusted_pgp_public_key.html" | true_relative_url }}) — configure trusted pgp public keys. + +* [`/configure/trusted_pgp_public_key/:name`]({{ "/documentation/reference/vault_plugin/configure/trusted_pgp_public_key/name.html" | true_relative_url }}) — read or delete the configured trusted pgp public key. + +* [`/publish`]({{ "/documentation/reference/vault_plugin/publish.html" | true_relative_url }}) — publish release channels. + +* [`/release`]({{ "/documentation/reference/vault_plugin/release.html" | true_relative_url }}) — perform a release. + +* [`/task`]({{ "/documentation/reference/vault_plugin/task.html" | true_relative_url }}) — get tasks. + +* [`/task/configure`]({{ "/documentation/reference/vault_plugin/task/configure.html" | true_relative_url }}) — configure the task manager. + +* [`/task/:uuid`]({{ "/documentation/reference/vault_plugin/task/uuid.html" | true_relative_url }}) — get task status. + +* [`/task/:uuid/cancel`]({{ "/documentation/reference/vault_plugin/task/uuid/cancel.html" | true_relative_url }}) — cancel the running task. + +* [`/task/:uuid/log`]({{ "/documentation/reference/vault_plugin/task/uuid/log.html" | true_relative_url }}) — get the task log. diff --git a/docs/_includes/reference/vault_plugin/publish.md b/docs/_includes/documentation/reference/vault_plugin/publish.md similarity index 100% rename from docs/_includes/reference/vault_plugin/publish.md rename to docs/_includes/documentation/reference/vault_plugin/publish.md diff --git a/docs/_includes/reference/vault_plugin/release.md b/docs/_includes/documentation/reference/vault_plugin/release.md similarity index 100% rename from docs/_includes/reference/vault_plugin/release.md rename to docs/_includes/documentation/reference/vault_plugin/release.md diff --git a/docs/_includes/reference/vault_plugin/task.md b/docs/_includes/documentation/reference/vault_plugin/task.md similarity index 100% rename from docs/_includes/reference/vault_plugin/task.md rename to docs/_includes/documentation/reference/vault_plugin/task.md diff --git a/docs/_includes/reference/vault_plugin/task/configure.md b/docs/_includes/documentation/reference/vault_plugin/task/configure.md similarity index 100% rename from docs/_includes/reference/vault_plugin/task/configure.md rename to docs/_includes/documentation/reference/vault_plugin/task/configure.md diff --git a/docs/_includes/reference/vault_plugin/task/uuid.md b/docs/_includes/documentation/reference/vault_plugin/task/uuid.md similarity index 100% rename from docs/_includes/reference/vault_plugin/task/uuid.md rename to docs/_includes/documentation/reference/vault_plugin/task/uuid.md diff --git a/docs/_includes/reference/vault_plugin/task/uuid/cancel.md b/docs/_includes/documentation/reference/vault_plugin/task/uuid/cancel.md similarity index 100% rename from docs/_includes/reference/vault_plugin/task/uuid/cancel.md rename to docs/_includes/documentation/reference/vault_plugin/task/uuid/cancel.md diff --git a/docs/_includes/reference/vault_plugin/task/uuid/log.md b/docs/_includes/documentation/reference/vault_plugin/task/uuid/log.md similarity index 100% rename from docs/_includes/reference/vault_plugin/task/uuid/log.md rename to docs/_includes/documentation/reference/vault_plugin/task/uuid/log.md diff --git a/docs/_includes/reference/vault_plugin/index.md b/docs/_includes/reference/vault_plugin/index.md deleted file mode 100644 index 4414c23d..00000000 --- a/docs/_includes/reference/vault_plugin/index.md +++ /dev/null @@ -1,27 +0,0 @@ -The trdl plugin builds and releases software versions, publishes the release channels, and ensures object storage security via saving data signed by keys (no one has access to those keys) and continuously rotating TUF keys and metadata. - -## Paths - -* [`/configure`]({{ "/reference/vault_plugin/configure.html" | true_relative_url }}) — configure the plugin. - -* [`/configure/git_credential`]({{ "/reference/vault_plugin/configure/git_credential.html" | true_relative_url }}) — configure git credentials. - -* [`/configure/pgp_signing_key`]({{ "/reference/vault_plugin/configure/pgp_signing_key.html" | true_relative_url }}) — configure a pgp key for signing release artifacts. - -* [`/configure/trusted_pgp_public_key`]({{ "/reference/vault_plugin/configure/trusted_pgp_public_key.html" | true_relative_url }}) — configure trusted pgp public keys. - -* [`/configure/trusted_pgp_public_key/:name`]({{ "/reference/vault_plugin/configure/trusted_pgp_public_key/name.html" | true_relative_url }}) — read or delete the configured trusted pgp public key. - -* [`/publish`]({{ "/reference/vault_plugin/publish.html" | true_relative_url }}) — publish release channels. - -* [`/release`]({{ "/reference/vault_plugin/release.html" | true_relative_url }}) — perform a release. - -* [`/task`]({{ "/reference/vault_plugin/task.html" | true_relative_url }}) — get tasks. - -* [`/task/configure`]({{ "/reference/vault_plugin/task/configure.html" | true_relative_url }}) — configure the task manager. - -* [`/task/:uuid`]({{ "/reference/vault_plugin/task/uuid.html" | true_relative_url }}) — get task status. - -* [`/task/:uuid/cancel`]({{ "/reference/vault_plugin/task/uuid/cancel.html" | true_relative_url }}) — cancel the running task. - -* [`/task/:uuid/log`]({{ "/reference/vault_plugin/task/uuid/log.html" | true_relative_url }}) — get the task log. diff --git a/docs/pages_en/QUICKSTART.md b/docs/pages_en/QUICKSTART.md index 4646b6e7..39a7b4bd 100644 --- a/docs/pages_en/QUICKSTART.md +++ b/docs/pages_en/QUICKSTART.md @@ -66,7 +66,7 @@ vault secrets enable -path=trdl-test-project vault-plugin-secrets-trdl You can enable the same plugin many times; however, you must use a unique path each time. For more information, refer to the [official documentation](https://www.vaultproject.io/docs/commands/secrets/enable). -Now let's configure the trdl plugin itself. We will use the [/configure](/reference/vault_plugin/configure.html#configure-plugin) API method to do this: +Now let's configure the trdl plugin itself. We will use the [/configure](/documentation/reference/vault_plugin/configure.html#configure-plugin) API method to do this: ```shell vault write trdl-test-project/configure @configuration.json @@ -91,7 +91,7 @@ The minimum number of GPG signatures required (`required_number_of_verified_sign #### Managing public parts of trusted GPG keys -The [/configure/trusted_pgp_public_key](/reference/vault_plugin/configure/trusted_pgp_public_key.html) group of API methods is used to handle the public parts of trusted GPG keys. +The [/configure/trusted_pgp_public_key](/documentation/reference/vault_plugin/configure/trusted_pgp_public_key.html) group of API methods is used to handle the public parts of trusted GPG keys. ## For a developer @@ -204,7 +204,7 @@ git signatures push Now that the tag has been created and signed by the necessary number of GPG keys, you can proceed to the release. -Use the [/release](/reference/vault_plugin/release.html#perform-a-release) API method to create a release. You can also use the following API methods for checking, controlling, and logging: [/task/:uuid](/reference/vault_plugin/task/uuid.html), [/task/:uuid/cancel](/reference/vault_plugin/task/uuid/cancel.html), and [/task/:uuid/log](/reference/vault_plugin/task/uuid/log.html). +Use the [/release](/documentation/reference/vault_plugin/release.html#perform-a-release) API method to create a release. You can also use the following API methods for checking, controlling, and logging: [/task/:uuid](/documentation/reference/vault_plugin/task/uuid.html), [/task/:uuid/cancel](/documentation/reference/vault_plugin/task/uuid/cancel.html), and [/task/:uuid/log](/documentation/reference/vault_plugin/task/uuid/log.html). A simplified version of the release process is available in the `release.sh` script in the [server/examples](https://github.com/werf/trdl/tree/main/server/examples) directory of the project repository. @@ -253,7 +253,7 @@ git signatures push Now that the commit has the required number of GPG signatures, you can publish the release channels. -Use the [/publish](/reference/vault_plugin/publish.html) API method to do this. You can also use the following API methods for checking, controlling, and logging: [/task/:uuid](/reference/vault_plugin/task/uuid.html), [/task/:uuid/cancel](/reference/vault_plugin/task/uuid/cancel.html), and [/task/:uuid/log](/reference/vault_plugin/task/uuid/log.html). +Use the [/publish](/documentation/reference/vault_plugin/publish.html) API method to do this. You can also use the following API methods for checking, controlling, and logging: [/task/:uuid](/documentation/reference/vault_plugin/task/uuid.html), [/task/:uuid/cancel](/documentation/reference/vault_plugin/task/uuid/cancel.html), and [/task/:uuid/log](/documentation/reference/vault_plugin/task/uuid/log.html). A streamlined version of the publishing process is available in the `publish.sh` script in the [server/examples](https://github.com/werf/trdl/tree/main/server/examples) directory of the project repository. diff --git a/docs/pages_en/documentation/reference/cli/overview.md b/docs/pages_en/documentation/reference/cli/overview.md new file mode 100644 index 00000000..92f16a97 --- /dev/null +++ b/docs/pages_en/documentation/reference/cli/overview.md @@ -0,0 +1,20 @@ +--- +title: Overview +permalink: documentation/reference/cli/overview.html +toc: false +--- + +Configuration commands: + - [trdl add]({{ "/documentation/reference/cli/trdl_add.html" | true_relative_url }}) — {% include /documentation/reference/cli/trdl_add.short.md %}. + - [trdl remove]({{ "/documentation/reference/cli/trdl_remove.html" | true_relative_url }}) — {% include /documentation/reference/cli/trdl_remove.short.md %}. + - [trdl list]({{ "/documentation/reference/cli/trdl_list.html" | true_relative_url }}) — {% include /documentation/reference/cli/trdl_list.short.md %}. + - [trdl set-default-channel]({{ "/documentation/reference/cli/trdl_set_default_channel.html" | true_relative_url }}) — {% include /documentation/reference/cli/trdl_set_default_channel.short.md %}. + +Main commands: + - [trdl use]({{ "/documentation/reference/cli/trdl_use.html" | true_relative_url }}) — {% include /documentation/reference/cli/trdl_use.short.md %}. + +Advanced commands: + - [trdl update]({{ "/documentation/reference/cli/trdl_update.html" | true_relative_url }}) — {% include /documentation/reference/cli/trdl_update.short.md %}. + - [trdl exec]({{ "/documentation/reference/cli/trdl_exec.html" | true_relative_url }}) — {% include /documentation/reference/cli/trdl_exec.short.md %}. + - [trdl dir-path]({{ "/documentation/reference/cli/trdl_dir_path.html" | true_relative_url }}) — {% include /documentation/reference/cli/trdl_dir_path.short.md %}. + - [trdl bin-path]({{ "/documentation/reference/cli/trdl_bin_path.html" | true_relative_url }}) — {% include /documentation/reference/cli/trdl_bin_path.short.md %}. diff --git a/docs/pages_en/documentation/reference/cli/trdl_add.md b/docs/pages_en/documentation/reference/cli/trdl_add.md new file mode 100644 index 00000000..e7adc4d9 --- /dev/null +++ b/docs/pages_en/documentation/reference/cli/trdl_add.md @@ -0,0 +1,6 @@ +--- +title: trdl add +permalink: documentation/reference/cli/trdl_add.html +--- + +{% include documentation/reference/cli/trdl_add.md %} diff --git a/docs/pages_en/documentation/reference/cli/trdl_bin_path.md b/docs/pages_en/documentation/reference/cli/trdl_bin_path.md new file mode 100644 index 00000000..8d18afbb --- /dev/null +++ b/docs/pages_en/documentation/reference/cli/trdl_bin_path.md @@ -0,0 +1,6 @@ +--- +title: trdl bin-path +permalink: documentation/reference/cli/trdl_bin_path.html +--- + +{% include documentation/reference/cli/trdl_bin_path.md %} diff --git a/docs/pages_en/documentation/reference/cli/trdl_dir_path.md b/docs/pages_en/documentation/reference/cli/trdl_dir_path.md new file mode 100644 index 00000000..f5724d0f --- /dev/null +++ b/docs/pages_en/documentation/reference/cli/trdl_dir_path.md @@ -0,0 +1,6 @@ +--- +title: trdl dir-path +permalink: documentation/reference/cli/trdl_dir_path.html +--- + +{% include documentation/reference/cli/trdl_dir_path.md %} diff --git a/docs/pages_en/documentation/reference/cli/trdl_exec.md b/docs/pages_en/documentation/reference/cli/trdl_exec.md new file mode 100644 index 00000000..24c134dc --- /dev/null +++ b/docs/pages_en/documentation/reference/cli/trdl_exec.md @@ -0,0 +1,6 @@ +--- +title: trdl exec +permalink: documentation/reference/cli/trdl_exec.html +--- + +{% include documentation/reference/cli/trdl_exec.md %} diff --git a/docs/pages_en/documentation/reference/cli/trdl_list.md b/docs/pages_en/documentation/reference/cli/trdl_list.md new file mode 100644 index 00000000..e6a88414 --- /dev/null +++ b/docs/pages_en/documentation/reference/cli/trdl_list.md @@ -0,0 +1,6 @@ +--- +title: trdl list +permalink: documentation/reference/cli/trdl_list.html +--- + +{% include documentation/reference/cli/trdl_list.md %} diff --git a/docs/pages_en/documentation/reference/cli/trdl_remove.md b/docs/pages_en/documentation/reference/cli/trdl_remove.md new file mode 100644 index 00000000..5bf550af --- /dev/null +++ b/docs/pages_en/documentation/reference/cli/trdl_remove.md @@ -0,0 +1,6 @@ +--- +title: trdl remove +permalink: documentation/reference/cli/trdl_remove.html +--- + +{% include documentation/reference/cli/trdl_remove.md %} diff --git a/docs/pages_en/documentation/reference/cli/trdl_set_default_channel.md b/docs/pages_en/documentation/reference/cli/trdl_set_default_channel.md new file mode 100644 index 00000000..a78784e5 --- /dev/null +++ b/docs/pages_en/documentation/reference/cli/trdl_set_default_channel.md @@ -0,0 +1,6 @@ +--- +title: trdl set-default-channel +permalink: documentation/reference/cli/trdl_set_default_channel.html +--- + +{% include documentation/reference/cli/trdl_set_default_channel.md %} diff --git a/docs/pages_en/documentation/reference/cli/trdl_update.md b/docs/pages_en/documentation/reference/cli/trdl_update.md new file mode 100644 index 00000000..f9a178f0 --- /dev/null +++ b/docs/pages_en/documentation/reference/cli/trdl_update.md @@ -0,0 +1,6 @@ +--- +title: trdl update +permalink: documentation/reference/cli/trdl_update.html +--- + +{% include documentation/reference/cli/trdl_update.md %} diff --git a/docs/pages_en/documentation/reference/cli/trdl_use.md b/docs/pages_en/documentation/reference/cli/trdl_use.md new file mode 100644 index 00000000..5b5ec04b --- /dev/null +++ b/docs/pages_en/documentation/reference/cli/trdl_use.md @@ -0,0 +1,6 @@ +--- +title: trdl use +permalink: documentation/reference/cli/trdl_use.html +--- + +{% include documentation/reference/cli/trdl_use.md %} diff --git a/docs/pages_en/documentation/reference/vault_plugin/configure.md b/docs/pages_en/documentation/reference/vault_plugin/configure.md new file mode 100644 index 00000000..2d4fafaf --- /dev/null +++ b/docs/pages_en/documentation/reference/vault_plugin/configure.md @@ -0,0 +1,6 @@ +--- +title: /configure +permalink: documentation/reference/vault_plugin/configure.html +--- + +{% include /documentation/reference/vault_plugin/configure.md %} diff --git a/docs/pages_en/documentation/reference/vault_plugin/configure/git_credential.md b/docs/pages_en/documentation/reference/vault_plugin/configure/git_credential.md new file mode 100644 index 00000000..22debd32 --- /dev/null +++ b/docs/pages_en/documentation/reference/vault_plugin/configure/git_credential.md @@ -0,0 +1,6 @@ +--- +title: /configure/git_credential +permalink: documentation/reference/vault_plugin/configure/git_credential.html +--- + +{% include /documentation/reference/vault_plugin/configure/git_credential.md %} diff --git a/docs/pages_en/documentation/reference/vault_plugin/configure/pgp_signing_key.md b/docs/pages_en/documentation/reference/vault_plugin/configure/pgp_signing_key.md new file mode 100644 index 00000000..2af1b4cf --- /dev/null +++ b/docs/pages_en/documentation/reference/vault_plugin/configure/pgp_signing_key.md @@ -0,0 +1,6 @@ +--- +title: /configure/pgp_signing_key +permalink: documentation/reference/vault_plugin/configure/pgp_signing_key.html +--- + +{% include /documentation/reference/vault_plugin/configure/pgp_signing_key.md %} diff --git a/docs/pages_en/documentation/reference/vault_plugin/configure/trusted_pgp_public_key.md b/docs/pages_en/documentation/reference/vault_plugin/configure/trusted_pgp_public_key.md new file mode 100644 index 00000000..7ac27885 --- /dev/null +++ b/docs/pages_en/documentation/reference/vault_plugin/configure/trusted_pgp_public_key.md @@ -0,0 +1,6 @@ +--- +title: /configure/trusted_pgp_public_key +permalink: documentation/reference/vault_plugin/configure/trusted_pgp_public_key.html +--- + +{% include /documentation/reference/vault_plugin/configure/trusted_pgp_public_key.md %} diff --git a/docs/pages_en/documentation/reference/vault_plugin/configure/trusted_pgp_public_key/name.md b/docs/pages_en/documentation/reference/vault_plugin/configure/trusted_pgp_public_key/name.md new file mode 100644 index 00000000..8c018fe5 --- /dev/null +++ b/docs/pages_en/documentation/reference/vault_plugin/configure/trusted_pgp_public_key/name.md @@ -0,0 +1,6 @@ +--- +title: /configure/trusted_pgp_public_key/:name +permalink: documentation/reference/vault_plugin/configure/trusted_pgp_public_key/name.html +--- + +{% include /documentation/reference/vault_plugin/configure/trusted_pgp_public_key/name.md %} diff --git a/docs/pages_en/documentation/reference/vault_plugin/index.md b/docs/pages_en/documentation/reference/vault_plugin/index.md new file mode 100644 index 00000000..3cd85a30 --- /dev/null +++ b/docs/pages_en/documentation/reference/vault_plugin/index.md @@ -0,0 +1,6 @@ +--- +title: Overview +permalink: documentation/reference/vault_plugin/index.html +--- + +{% include /documentation/reference/vault_plugin/index.md %} diff --git a/docs/pages_en/documentation/reference/vault_plugin/publish.md b/docs/pages_en/documentation/reference/vault_plugin/publish.md new file mode 100644 index 00000000..4acb708f --- /dev/null +++ b/docs/pages_en/documentation/reference/vault_plugin/publish.md @@ -0,0 +1,6 @@ +--- +title: /publish +permalink: documentation/reference/vault_plugin/publish.html +--- + +{% include /documentation/reference/vault_plugin/publish.md %} diff --git a/docs/pages_en/documentation/reference/vault_plugin/release.md b/docs/pages_en/documentation/reference/vault_plugin/release.md new file mode 100644 index 00000000..35e2d051 --- /dev/null +++ b/docs/pages_en/documentation/reference/vault_plugin/release.md @@ -0,0 +1,6 @@ +--- +title: /release +permalink: documentation/reference/vault_plugin/release.html +--- + +{% include /documentation/reference/vault_plugin/release.md %} diff --git a/docs/pages_en/documentation/reference/vault_plugin/task.md b/docs/pages_en/documentation/reference/vault_plugin/task.md new file mode 100644 index 00000000..fa9b4894 --- /dev/null +++ b/docs/pages_en/documentation/reference/vault_plugin/task.md @@ -0,0 +1,6 @@ +--- +title: /task +permalink: documentation/reference/vault_plugin/task.html +--- + +{% include /documentation/reference/vault_plugin/task.md %} diff --git a/docs/pages_en/documentation/reference/vault_plugin/task/configure.md b/docs/pages_en/documentation/reference/vault_plugin/task/configure.md new file mode 100644 index 00000000..3d2b5e3b --- /dev/null +++ b/docs/pages_en/documentation/reference/vault_plugin/task/configure.md @@ -0,0 +1,6 @@ +--- +title: /task/configure +permalink: documentation/reference/vault_plugin/task/configure.html +--- + +{% include /documentation/reference/vault_plugin/task/configure.md %} diff --git a/docs/pages_en/documentation/reference/vault_plugin/task/uuid.md b/docs/pages_en/documentation/reference/vault_plugin/task/uuid.md new file mode 100644 index 00000000..99d76cac --- /dev/null +++ b/docs/pages_en/documentation/reference/vault_plugin/task/uuid.md @@ -0,0 +1,6 @@ +--- +title: /task/:uuid +permalink: documentation/reference/vault_plugin/task/uuid.html +--- + +{% include /documentation/reference/vault_plugin/task/uuid.md %} diff --git a/docs/pages_en/documentation/reference/vault_plugin/task/uuid/cancel.md b/docs/pages_en/documentation/reference/vault_plugin/task/uuid/cancel.md new file mode 100644 index 00000000..d05a873b --- /dev/null +++ b/docs/pages_en/documentation/reference/vault_plugin/task/uuid/cancel.md @@ -0,0 +1,6 @@ +--- +title: /task/:uuid/cancel +permalink: documentation/reference/vault_plugin/task/uuid/cancel.html +--- + +{% include /documentation/reference/vault_plugin/task/uuid/cancel.md %} diff --git a/docs/pages_en/documentation/reference/vault_plugin/task/uuid/log.md b/docs/pages_en/documentation/reference/vault_plugin/task/uuid/log.md new file mode 100644 index 00000000..d510d3a0 --- /dev/null +++ b/docs/pages_en/documentation/reference/vault_plugin/task/uuid/log.md @@ -0,0 +1,6 @@ +--- +title: /task/:uuid/log +permalink: documentation/reference/vault_plugin/task/uuid/log.html +--- + +{% include /documentation/reference/vault_plugin/task/uuid/log.md %} diff --git a/docs/pages_en/reference/cli/overview.md b/docs/pages_en/reference/cli/overview.md deleted file mode 100644 index 17639738..00000000 --- a/docs/pages_en/reference/cli/overview.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Overview -permalink: reference/cli/overview.html -toc: false ---- - -Configuration commands: - - [trdl add]({{ "/reference/cli/trdl_add.html" | true_relative_url }}) — {% include /reference/cli/trdl_add.short.md %}. - - [trdl remove]({{ "/reference/cli/trdl_remove.html" | true_relative_url }}) — {% include /reference/cli/trdl_remove.short.md %}. - - [trdl list]({{ "/reference/cli/trdl_list.html" | true_relative_url }}) — {% include /reference/cli/trdl_list.short.md %}. - - [trdl set-default-channel]({{ "/reference/cli/trdl_set_default_channel.html" | true_relative_url }}) — {% include /reference/cli/trdl_set_default_channel.short.md %}. - -Main commands: - - [trdl use]({{ "/reference/cli/trdl_use.html" | true_relative_url }}) — {% include /reference/cli/trdl_use.short.md %}. - -Advanced commands: - - [trdl update]({{ "/reference/cli/trdl_update.html" | true_relative_url }}) — {% include /reference/cli/trdl_update.short.md %}. - - [trdl exec]({{ "/reference/cli/trdl_exec.html" | true_relative_url }}) — {% include /reference/cli/trdl_exec.short.md %}. - - [trdl dir-path]({{ "/reference/cli/trdl_dir_path.html" | true_relative_url }}) — {% include /reference/cli/trdl_dir_path.short.md %}. - - [trdl bin-path]({{ "/reference/cli/trdl_bin_path.html" | true_relative_url }}) — {% include /reference/cli/trdl_bin_path.short.md %}. diff --git a/docs/pages_en/reference/cli/trdl_add.md b/docs/pages_en/reference/cli/trdl_add.md deleted file mode 100644 index fa162dee..00000000 --- a/docs/pages_en/reference/cli/trdl_add.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: trdl add -permalink: reference/cli/trdl_add.html ---- - -{% include /reference/cli/trdl_add.md %} diff --git a/docs/pages_en/reference/cli/trdl_bin_path.md b/docs/pages_en/reference/cli/trdl_bin_path.md deleted file mode 100644 index 28528d78..00000000 --- a/docs/pages_en/reference/cli/trdl_bin_path.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: trdl bin-path -permalink: reference/cli/trdl_bin_path.html ---- - -{% include /reference/cli/trdl_bin_path.md %} diff --git a/docs/pages_en/reference/cli/trdl_dir_path.md b/docs/pages_en/reference/cli/trdl_dir_path.md deleted file mode 100644 index 0bef1254..00000000 --- a/docs/pages_en/reference/cli/trdl_dir_path.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: trdl dir-path -permalink: reference/cli/trdl_dir_path.html ---- - -{% include /reference/cli/trdl_dir_path.md %} diff --git a/docs/pages_en/reference/cli/trdl_exec.md b/docs/pages_en/reference/cli/trdl_exec.md deleted file mode 100644 index f2157adb..00000000 --- a/docs/pages_en/reference/cli/trdl_exec.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: trdl exec -permalink: reference/cli/trdl_exec.html ---- - -{% include /reference/cli/trdl_exec.md %} diff --git a/docs/pages_en/reference/cli/trdl_list.md b/docs/pages_en/reference/cli/trdl_list.md deleted file mode 100644 index 397c898c..00000000 --- a/docs/pages_en/reference/cli/trdl_list.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: trdl list -permalink: reference/cli/trdl_list.html ---- - -{% include /reference/cli/trdl_list.md %} diff --git a/docs/pages_en/reference/cli/trdl_remove.md b/docs/pages_en/reference/cli/trdl_remove.md deleted file mode 100644 index 39c55f71..00000000 --- a/docs/pages_en/reference/cli/trdl_remove.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: trdl remove -permalink: reference/cli/trdl_remove.html ---- - -{% include /reference/cli/trdl_remove.md %} diff --git a/docs/pages_en/reference/cli/trdl_set_default_channel.md b/docs/pages_en/reference/cli/trdl_set_default_channel.md deleted file mode 100644 index ba8022ee..00000000 --- a/docs/pages_en/reference/cli/trdl_set_default_channel.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: trdl set-default-channel -permalink: reference/cli/trdl_set_default_channel.html ---- - -{% include /reference/cli/trdl_set_default_channel.md %} diff --git a/docs/pages_en/reference/cli/trdl_update.md b/docs/pages_en/reference/cli/trdl_update.md deleted file mode 100644 index 40e423ba..00000000 --- a/docs/pages_en/reference/cli/trdl_update.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: trdl update -permalink: reference/cli/trdl_update.html ---- - -{% include /reference/cli/trdl_update.md %} diff --git a/docs/pages_en/reference/cli/trdl_use.md b/docs/pages_en/reference/cli/trdl_use.md deleted file mode 100644 index 97397056..00000000 --- a/docs/pages_en/reference/cli/trdl_use.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: trdl use -permalink: reference/cli/trdl_use.html ---- - -{% include /reference/cli/trdl_use.md %} diff --git a/docs/pages_en/reference/trdl_yaml.md b/docs/pages_en/reference/trdl_yaml.md index 6fe575fe..bb1687c0 100644 --- a/docs/pages_en/reference/trdl_yaml.md +++ b/docs/pages_en/reference/trdl_yaml.md @@ -34,7 +34,7 @@ windows-any any-any ``` -To use the basic functions of the trdl client (e.g., the [trdl use](/reference/cli/trdl_use.html) command), you need to save the executables in the `bin` subdirectory. +To use the basic functions of the trdl client (e.g., the [trdl use](/documentation/reference/cli/trdl_use.html) command), you need to save the executables in the `bin` subdirectory. As a result, for most projects, the `/result` directory after the build should have the following structure: ``` diff --git a/docs/pages_en/reference/vault_plugin/configure.md b/docs/pages_en/reference/vault_plugin/configure.md deleted file mode 100644 index 517ff2c2..00000000 --- a/docs/pages_en/reference/vault_plugin/configure.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: /configure -permalink: reference/vault_plugin/configure.html ---- - -{% include /reference/vault_plugin/configure.md %} diff --git a/docs/pages_en/reference/vault_plugin/configure/git_credential.md b/docs/pages_en/reference/vault_plugin/configure/git_credential.md deleted file mode 100644 index b5f308c5..00000000 --- a/docs/pages_en/reference/vault_plugin/configure/git_credential.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: /configure/git_credential -permalink: reference/vault_plugin/configure/git_credential.html ---- - -{% include /reference/vault_plugin/configure/git_credential.md %} diff --git a/docs/pages_en/reference/vault_plugin/configure/pgp_signing_key.md b/docs/pages_en/reference/vault_plugin/configure/pgp_signing_key.md deleted file mode 100644 index c3a8f756..00000000 --- a/docs/pages_en/reference/vault_plugin/configure/pgp_signing_key.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: /configure/pgp_signing_key -permalink: reference/vault_plugin/configure/pgp_signing_key.html ---- - -{% include /reference/vault_plugin/configure/pgp_signing_key.md %} diff --git a/docs/pages_en/reference/vault_plugin/configure/trusted_pgp_public_key.md b/docs/pages_en/reference/vault_plugin/configure/trusted_pgp_public_key.md deleted file mode 100644 index 94a8fefc..00000000 --- a/docs/pages_en/reference/vault_plugin/configure/trusted_pgp_public_key.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: /configure/trusted_pgp_public_key -permalink: reference/vault_plugin/configure/trusted_pgp_public_key.html ---- - -{% include /reference/vault_plugin/configure/trusted_pgp_public_key.md %} diff --git a/docs/pages_en/reference/vault_plugin/configure/trusted_pgp_public_key/name.md b/docs/pages_en/reference/vault_plugin/configure/trusted_pgp_public_key/name.md deleted file mode 100644 index 26c563cb..00000000 --- a/docs/pages_en/reference/vault_plugin/configure/trusted_pgp_public_key/name.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: /configure/trusted_pgp_public_key/:name -permalink: reference/vault_plugin/configure/trusted_pgp_public_key/name.html ---- - -{% include /reference/vault_plugin/configure/trusted_pgp_public_key/name.md %} diff --git a/docs/pages_en/reference/vault_plugin/index.md b/docs/pages_en/reference/vault_plugin/index.md deleted file mode 100644 index 6ce1c350..00000000 --- a/docs/pages_en/reference/vault_plugin/index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Overview -permalink: reference/vault_plugin/index.html ---- - -{% include /reference/vault_plugin/index.md %} diff --git a/docs/pages_en/reference/vault_plugin/publish.md b/docs/pages_en/reference/vault_plugin/publish.md deleted file mode 100644 index 4a118d7e..00000000 --- a/docs/pages_en/reference/vault_plugin/publish.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: /publish -permalink: reference/vault_plugin/publish.html ---- - -{% include /reference/vault_plugin/publish.md %} diff --git a/docs/pages_en/reference/vault_plugin/release.md b/docs/pages_en/reference/vault_plugin/release.md deleted file mode 100644 index fe2da283..00000000 --- a/docs/pages_en/reference/vault_plugin/release.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: /release -permalink: reference/vault_plugin/release.html ---- - -{% include /reference/vault_plugin/release.md %} diff --git a/docs/pages_en/reference/vault_plugin/task.md b/docs/pages_en/reference/vault_plugin/task.md deleted file mode 100644 index a4675667..00000000 --- a/docs/pages_en/reference/vault_plugin/task.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: /task -permalink: reference/vault_plugin/task.html ---- - -{% include /reference/vault_plugin/task.md %} diff --git a/docs/pages_en/reference/vault_plugin/task/configure.md b/docs/pages_en/reference/vault_plugin/task/configure.md deleted file mode 100644 index 0abae677..00000000 --- a/docs/pages_en/reference/vault_plugin/task/configure.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: /task/configure -permalink: reference/vault_plugin/task/configure.html ---- - -{% include /reference/vault_plugin/task/configure.md %} diff --git a/docs/pages_en/reference/vault_plugin/task/uuid.md b/docs/pages_en/reference/vault_plugin/task/uuid.md deleted file mode 100644 index aeba7e4c..00000000 --- a/docs/pages_en/reference/vault_plugin/task/uuid.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: /task/:uuid -permalink: reference/vault_plugin/task/uuid.html ---- - -{% include /reference/vault_plugin/task/uuid.md %} diff --git a/docs/pages_en/reference/vault_plugin/task/uuid/cancel.md b/docs/pages_en/reference/vault_plugin/task/uuid/cancel.md deleted file mode 100644 index c8eba5c9..00000000 --- a/docs/pages_en/reference/vault_plugin/task/uuid/cancel.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: /task/:uuid/cancel -permalink: reference/vault_plugin/task/uuid/cancel.html ---- - -{% include /reference/vault_plugin/task/uuid/cancel.md %} diff --git a/docs/pages_en/reference/vault_plugin/task/uuid/log.md b/docs/pages_en/reference/vault_plugin/task/uuid/log.md deleted file mode 100644 index c1f15f6e..00000000 --- a/docs/pages_en/reference/vault_plugin/task/uuid/log.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: /task/:uuid/log -permalink: reference/vault_plugin/task/uuid/log.html ---- - -{% include /reference/vault_plugin/task/uuid/log.md %} diff --git a/docs/pages_ru/QUICKSTART.md b/docs/pages_ru/QUICKSTART.md index 684c51df..5b8dcf93 100644 --- a/docs/pages_ru/QUICKSTART.md +++ b/docs/pages_ru/QUICKSTART.md @@ -65,7 +65,7 @@ vault secrets enable -path=trdl-test-project vault-plugin-secrets-trdl Один и тот же плагин можно подключать множество раз, но каждый раз с уникальным путем. Подробнее об этом — [в официальной документации](https://www.vaultproject.io/docs/commands/secrets/enable). -Теперь настроим сам плагин trdl. Для конфигурации необходимо использовать метод API [/configure](/reference/vault_plugin/configure.html#configure-plugin): +Теперь настроим сам плагин trdl. Для конфигурации необходимо использовать метод API [/configure](/documentation/reference/vault_plugin/configure.html#configure-plugin): ```shell vault write trdl-test-project/configure @configuration.json @@ -90,7 +90,7 @@ vault write trdl-test-project/configure @configuration.json #### Управление публичными частями доверенных GPG-ключей -Для работы с публичными частями доверенных GPG-ключей используется группа методов API [/configure/trusted_pgp_public_key](/reference/vault_plugin/configure/trusted_pgp_public_key.html). +Для работы с публичными частями доверенных GPG-ключей используется группа методов API [/configure/trusted_pgp_public_key](/documentation/reference/vault_plugin/configure/trusted_pgp_public_key.html). **Добавление ключа** @@ -337,7 +337,7 @@ git signatures push Тег создан, необходимое количество GPG-подписей есть — можно переходить непосредственно к релизу. -Для создания релиза используйте метод API [/release](/reference/vault_plugin/release.html#perform-a-release). Проверка, контроль и логирование можно организовывать с помощью методов API [/task/:uuid](/reference/vault_plugin/task/uuid.html), [/task/:uuid/cancel](/reference/vault_plugin/task/uuid/cancel.html) и [/task/:uuid/log](/reference/vault_plugin/task/uuid/log.html). +Для создания релиза используйте метод API [/release](/documentation/reference/vault_plugin/release.html#perform-a-release). Проверка, контроль и логирование можно организовывать с помощью методов API [/task/:uuid](/documentation/reference/vault_plugin/task/uuid.html), [/task/:uuid/cancel](/documentation/reference/vault_plugin/task/uuid/cancel.html) и [/task/:uuid/log](/documentation/reference/vault_plugin/task/uuid/log.html). Упрощённая версия релизного процесса представлена в скрипте `release.sh`, который находится в каталоге [server/examples](https://github.com/werf/trdl/tree/main/server/examples) репозитория проекта. @@ -386,7 +386,7 @@ git signatures push Необходимое количество GPG-подписей добавлено — можно переходить непосредственно к публикации каналов обновлений. -При публикации используйте метод API [/publish](/reference/vault_plugin/publish.html). Проверку, контроль и логирование можно организовать с помощью методов API [/task/:uuid](/reference/vault_plugin/task/uuid.html), [/task/:uuid/cancel](/reference/vault_plugin/task/uuid/cancel.html) и [/task/:uuid/log](/reference/vault_plugin/task/uuid/log.html). +При публикации используйте метод API [/publish](/documentation/reference/vault_plugin/publish.html). Проверку, контроль и логирование можно организовать с помощью методов API [/task/:uuid](/documentation/reference/vault_plugin/task/uuid.html), [/task/:uuid/cancel](/documentation/reference/vault_plugin/task/uuid/cancel.html) и [/task/:uuid/log](/documentation/reference/vault_plugin/task/uuid/log.html). Упрощённая версия процесса публикации представлена в скрипте `publish.sh`, который находится в каталоге [server/examples](https://github.com/werf/trdl/tree/main/server/examples) репозитория проекта. diff --git a/docs/pages_ru/documentation/reference/cli b/docs/pages_ru/documentation/reference/cli new file mode 120000 index 00000000..1395b4a2 --- /dev/null +++ b/docs/pages_ru/documentation/reference/cli @@ -0,0 +1 @@ +../../../pages_en/documentation/reference/cli \ No newline at end of file diff --git a/docs/pages_ru/documentation/reference/vault_plugin b/docs/pages_ru/documentation/reference/vault_plugin new file mode 120000 index 00000000..2d0c32d8 --- /dev/null +++ b/docs/pages_ru/documentation/reference/vault_plugin @@ -0,0 +1 @@ +../../../pages_en/documentation/reference/vault_plugin \ No newline at end of file diff --git a/docs/pages_ru/reference/cli b/docs/pages_ru/reference/cli deleted file mode 120000 index dafad659..00000000 --- a/docs/pages_ru/reference/cli +++ /dev/null @@ -1 +0,0 @@ -../../pages_en/reference/cli/ \ No newline at end of file diff --git a/docs/pages_ru/reference/trdl_yaml.md b/docs/pages_ru/reference/trdl_yaml.md index 7add3258..343275cd 100644 --- a/docs/pages_ru/reference/trdl_yaml.md +++ b/docs/pages_ru/reference/trdl_yaml.md @@ -34,7 +34,7 @@ windows-any any-any ``` -Чтобы использовать основную функциональность trdl-клиента (к примеру, команду [trdl use](/reference/cli/trdl_use.html)), необходимо сохранять исполняемые файлы в поддиректории `bin`. +Чтобы использовать основную функциональность trdl-клиента (к примеру, команду [trdl use](/documentation/reference/cli/trdl_use.html)), необходимо сохранять исполняемые файлы в поддиректории `bin`. В итоге для большинства проектов справедлива следующая структура директории `/result` после сборки: ``` diff --git a/docs/pages_ru/reference/vault_plugin b/docs/pages_ru/reference/vault_plugin deleted file mode 120000 index aeeb959a..00000000 --- a/docs/pages_ru/reference/vault_plugin +++ /dev/null @@ -1 +0,0 @@ -../../pages_en/reference/vault_plugin/ \ No newline at end of file From fd2758f10a1c5a3cc1f3fbe3cddb04e9e173a231 Mon Sep 17 00:00:00 2001 From: Alexey Igrychev Date: Mon, 7 Feb 2022 21:22:19 +0000 Subject: [PATCH 02/16] site: move reference to documentation (others) Signed-off-by: Alexey Igrychev --- .../reference/configuration_table_directive.html | 4 ++-- .../reference/trdl_channels_yaml/table.html | 2 +- .../reference/trdl_yaml/example_build_sh.md.liquid | 0 .../reference/trdl_yaml/example_result.md.liquid | 0 .../reference/trdl_yaml/example_trdl_yaml.md.liquid | 0 .../{ => documentation}/reference/trdl_yaml/table.html | 2 +- docs/pages_en/QUICKSTART.md | 10 +++++----- .../reference/trdl_channels_yaml.md | 4 ++-- .../{ => documentation}/reference/trdl_yaml.md | 10 +++++----- .../reference/tuf_repository_layout.md | 2 +- docs/pages_ru/QUICKSTART.md | 10 +++++----- .../reference/trdl_channels_yaml.md | 4 ++-- .../{ => documentation}/reference/trdl_yaml.md | 10 +++++----- .../reference/tuf_repository_layout.md | 3 +-- 14 files changed, 30 insertions(+), 31 deletions(-) rename docs/_includes/{ => documentation}/reference/configuration_table_directive.html (91%) rename docs/_includes/{ => documentation}/reference/trdl_channels_yaml/table.html (75%) rename docs/_includes/{ => documentation}/reference/trdl_yaml/example_build_sh.md.liquid (100%) rename docs/_includes/{ => documentation}/reference/trdl_yaml/example_result.md.liquid (100%) rename docs/_includes/{ => documentation}/reference/trdl_yaml/example_trdl_yaml.md.liquid (100%) rename docs/_includes/{ => documentation}/reference/trdl_yaml/table.html (74%) rename docs/pages_en/{ => documentation}/reference/trdl_channels_yaml.md (86%) rename docs/pages_en/{ => documentation}/reference/trdl_yaml.md (86%) rename docs/pages_en/{ => documentation}/reference/tuf_repository_layout.md (98%) rename docs/pages_ru/{ => documentation}/reference/trdl_channels_yaml.md (88%) rename docs/pages_ru/{ => documentation}/reference/trdl_yaml.md (91%) rename docs/pages_ru/{ => documentation}/reference/tuf_repository_layout.md (97%) diff --git a/docs/_includes/reference/configuration_table_directive.html b/docs/_includes/documentation/reference/configuration_table_directive.html similarity index 91% rename from docs/_includes/reference/configuration_table_directive.html rename to docs/_includes/documentation/reference/configuration_table_directive.html index 650ac753..9cbcd086 100644 --- a/docs/_includes/reference/configuration_table_directive.html +++ b/docs/_includes/documentation/reference/configuration_table_directive.html @@ -92,7 +92,7 @@ {% assign nestedElmIndent = include.indent | plus: 1 %} {% assign nestedDirectiveClasses = directiveClasses %} {% assign nestedDirectiveCollapsedClasses = directiveCollapsedClasses %} -{% include reference/configuration_table_directive.html directive=directive indent=nestedElmIndent isAttr=true directiveClasses=nestedDirectiveClasses directiveCollapsedClasses=nestedDirectiveCollapsedClasses %} +{% include /documentation/reference/configuration_table_directive.html directive=directive indent=nestedElmIndent isAttr=true directiveClasses=nestedDirectiveClasses directiveCollapsedClasses=nestedDirectiveCollapsedClasses %} {% assign directiveClasses = nestedDirectiveClasses %} {% assign directiveCollapsedClasses = nestedDirectiveCollapsedClasses %} {% endfor %} @@ -101,7 +101,7 @@ {% assign nestedElmIndent = include.indent | plus: 1 %} {% assign nestedDirectiveClasses = directiveClasses %} {% assign nestedDirectiveCollapsedClasses = directiveCollapsedClasses %} -{% include reference/configuration_table_directive.html directive=directive indent=nestedElmIndent isElm=true elmIndex=forloop.index directiveClasses=nestedDirectiveClasses directiveCollapsedClasses=nestedDirectiveCollapsedClasses %} +{% include /documentation/reference/configuration_table_directive.html directive=directive indent=nestedElmIndent isElm=true elmIndex=forloop.index directiveClasses=nestedDirectiveClasses directiveCollapsedClasses=nestedDirectiveCollapsedClasses %} {% assign directiveClasses = nestedDirectiveClasses %} {% assign directiveCollapsedClasses = nestedDirectiveCollapsedClasses %} {% endfor %} diff --git a/docs/_includes/reference/trdl_channels_yaml/table.html b/docs/_includes/documentation/reference/trdl_channels_yaml/table.html similarity index 75% rename from docs/_includes/reference/trdl_channels_yaml/table.html rename to docs/_includes/documentation/reference/trdl_channels_yaml/table.html index 4bc99ae6..e3d5b7f9 100644 --- a/docs/_includes/reference/trdl_channels_yaml/table.html +++ b/docs/_includes/documentation/reference/trdl_channels_yaml/table.html @@ -4,7 +4,7 @@ {{ "tableLineCounter" | reset_shared_counter }} {% for directive in site.data.trdl_channels.directives %} - {% include reference/configuration_table_directive.html directive=directive %} + {% include documentation/reference/configuration_table_directive.html directive=directive %} {% endfor %} \ No newline at end of file diff --git a/docs/_includes/reference/trdl_yaml/example_build_sh.md.liquid b/docs/_includes/documentation/reference/trdl_yaml/example_build_sh.md.liquid similarity index 100% rename from docs/_includes/reference/trdl_yaml/example_build_sh.md.liquid rename to docs/_includes/documentation/reference/trdl_yaml/example_build_sh.md.liquid diff --git a/docs/_includes/reference/trdl_yaml/example_result.md.liquid b/docs/_includes/documentation/reference/trdl_yaml/example_result.md.liquid similarity index 100% rename from docs/_includes/reference/trdl_yaml/example_result.md.liquid rename to docs/_includes/documentation/reference/trdl_yaml/example_result.md.liquid diff --git a/docs/_includes/reference/trdl_yaml/example_trdl_yaml.md.liquid b/docs/_includes/documentation/reference/trdl_yaml/example_trdl_yaml.md.liquid similarity index 100% rename from docs/_includes/reference/trdl_yaml/example_trdl_yaml.md.liquid rename to docs/_includes/documentation/reference/trdl_yaml/example_trdl_yaml.md.liquid diff --git a/docs/_includes/reference/trdl_yaml/table.html b/docs/_includes/documentation/reference/trdl_yaml/table.html similarity index 74% rename from docs/_includes/reference/trdl_yaml/table.html rename to docs/_includes/documentation/reference/trdl_yaml/table.html index e56dbe41..8a749e87 100644 --- a/docs/_includes/reference/trdl_yaml/table.html +++ b/docs/_includes/documentation/reference/trdl_yaml/table.html @@ -4,7 +4,7 @@ {{ "tableLineCounter" | reset_shared_counter }} {% for directive in site.data.trdl.directives %} - {% include reference/configuration_table_directive.html directive=directive %} + {% include documentation/reference/configuration_table_directive.html directive=directive %} {% endfor %} \ No newline at end of file diff --git a/docs/pages_en/QUICKSTART.md b/docs/pages_en/QUICKSTART.md index 39a7b4bd..e44209d5 100644 --- a/docs/pages_en/QUICKSTART.md +++ b/docs/pages_en/QUICKSTART.md @@ -166,17 +166,17 @@ Commands As a basic example of creating and arranging release artifacts for multiple platforms, let's deliver the script that outputs a release tag when run. -All build parameters, such as environment and build instructions, are defined in the [trdl.yaml](/reference/trdl_yaml.html) file. +All build parameters, such as environment and build instructions, are defined in the [trdl.yaml](/documentation/reference/trdl_yaml.html) file. -**Caution.** Release artifacts must have a specific directory structure to deliver to different platforms and handle the executable files efficiently when using trdl-client ([learn more about using artifacts](/reference/trdl_yaml.html#release-artifacts-layout)). +**Caution.** Release artifacts must have a specific directory structure to deliver to different platforms and handle the executable files efficiently when using trdl-client ([learn more about using artifacts](/documentation/reference/trdl_yaml.html#release-artifacts-layout)). #### trdl.yaml -{% include reference/trdl_yaml/example_trdl_yaml.md.liquid %} +{% include documentation/reference/trdl_yaml/example_trdl_yaml.md.liquid %} #### build.sh -{% include reference/trdl_yaml/example_build_sh.md.liquid %} +{% include documentation/reference/trdl_yaml/example_build_sh.md.liquid %} Add both files and commit them to Git. @@ -218,7 +218,7 @@ Four environment variables must be set before running the script: ### Publishing the release channels -You must publish the release for the user to access it. To do this, switch to the main branch and add to the repository the [trdl_channels.yaml](/reference/trdl_channels_yaml.html) file that describes the release channels. +You must publish the release for the user to access it. To do this, switch to the main branch and add to the repository the [trdl_channels.yaml](/documentation/reference/trdl_channels_yaml.html) file that describes the release channels. #### trdl_channels.yaml: diff --git a/docs/pages_en/reference/trdl_channels_yaml.md b/docs/pages_en/documentation/reference/trdl_channels_yaml.md similarity index 86% rename from docs/pages_en/reference/trdl_channels_yaml.md rename to docs/pages_en/documentation/reference/trdl_channels_yaml.md index 8b2783c6..4838950c 100644 --- a/docs/pages_en/reference/trdl_channels_yaml.md +++ b/docs/pages_en/documentation/reference/trdl_channels_yaml.md @@ -1,6 +1,6 @@ --- title: trdl_channels.yaml -permalink: reference/trdl_channels_yaml.html +permalink: documentation/reference/trdl_channels_yaml.html toc: false --- @@ -8,7 +8,7 @@ The `trdl_channels.yaml` configuration contains groups, release channels, and ve When publishing, trdl reads `trdl_channels.yaml` from the default Git repository branch (unless explicitly overridden by the vault plugin configuration) and applies the changes. Updates then become available to users. -{% include reference/trdl_channels_yaml/table.html %} +{% include documentation/reference/trdl_channels_yaml/table.html %} ## Example diff --git a/docs/pages_en/reference/trdl_yaml.md b/docs/pages_en/documentation/reference/trdl_yaml.md similarity index 86% rename from docs/pages_en/reference/trdl_yaml.md rename to docs/pages_en/documentation/reference/trdl_yaml.md index bb1687c0..0349fb06 100644 --- a/docs/pages_en/reference/trdl_yaml.md +++ b/docs/pages_en/documentation/reference/trdl_yaml.md @@ -1,6 +1,6 @@ --- title: trdl.yaml -permalink: reference/trdl_yaml.html +permalink: documentation/reference/trdl_yaml.html toc: false --- @@ -12,7 +12,7 @@ On release, trdl reads `trdl.yaml` from the Git tag and performs the build: - Executes build instructions in the `/git` directory. - Saves release artifacts from the `/result` directory. -{% include reference/trdl_yaml/table.html %} +{% include documentation/reference/trdl_yaml/table.html %} ## Release artifacts layout @@ -58,12 +58,12 @@ Here: ### trdl.yaml -{% include reference/trdl_yaml/example_trdl_yaml.md.liquid %} +{% include documentation/reference/trdl_yaml/example_trdl_yaml.md.liquid %} ### build.sh -{% include reference/trdl_yaml/example_build_sh.md.liquid %} +{% include documentation/reference/trdl_yaml/example_build_sh.md.liquid %} ### Below is the structure of the /result directory after running assembly instructions -{% include reference/trdl_yaml/example_result.md.liquid %} +{% include documentation/reference/trdl_yaml/example_result.md.liquid %} diff --git a/docs/pages_en/reference/tuf_repository_layout.md b/docs/pages_en/documentation/reference/tuf_repository_layout.md similarity index 98% rename from docs/pages_en/reference/tuf_repository_layout.md rename to docs/pages_en/documentation/reference/tuf_repository_layout.md index b6fb1db1..5b3ae698 100644 --- a/docs/pages_en/reference/tuf_repository_layout.md +++ b/docs/pages_en/documentation/reference/tuf_repository_layout.md @@ -1,6 +1,6 @@ --- title: TUF repository layout -permalink: reference/tuf_repository_layout.html +permalink: documentation/reference/tuf_repository_layout.html toc: true --- diff --git a/docs/pages_ru/QUICKSTART.md b/docs/pages_ru/QUICKSTART.md index 5b8dcf93..f0ca510d 100644 --- a/docs/pages_ru/QUICKSTART.md +++ b/docs/pages_ru/QUICKSTART.md @@ -299,17 +299,17 @@ Commands Рассмотрим простой пример создания и организации артефактов релиза для нескольких платформ: организуем доставку скрипта, который при запуске будет выводить тег релиза. -Вся конфигурация сборки — окружение и сборочные инструкции — описывается в файле [trdl.yaml](/reference/trdl_yaml.html). +Вся конфигурация сборки — окружение и сборочные инструкции — описывается в файле [trdl.yaml](/documentation/reference/trdl_yaml.html). -**Важно.** Артефакты релиза должны иметь определённую организацию директорий для доставки на различные платформы и эффективной работы с исполняемыми файлами при использовании trdl-клиента ([подробнее об организации артефактов](/reference/trdl_yaml.html#организация-артефактов-релиза)). +**Важно.** Артефакты релиза должны иметь определённую организацию директорий для доставки на различные платформы и эффективной работы с исполняемыми файлами при использовании trdl-клиента ([подробнее об организации артефактов](/documentation/reference/trdl_yaml.html#организация-артефактов-релиза)). #### trdl.yaml -{% include reference/trdl_yaml/example_trdl_yaml.md.liquid %} +{% include documentation/reference/trdl_yaml/example_trdl_yaml.md.liquid %} #### build.sh -{% include reference/trdl_yaml/example_build_sh.md.liquid %} +{% include documentation/reference/trdl_yaml/example_build_sh.md.liquid %} Оба файла добавляем и коммитим в Git. @@ -351,7 +351,7 @@ git signatures push ### Публикация каналов обновлений -Чтобы у пользователя был доступ к релизу, его нужно опубликовать. Для этого переключитесь на основную ветку, добавьте в репозиторий файл с описанием каналов обновлений [trdl_channels.yaml](/reference/trdl_channels_yaml.html). +Чтобы у пользователя был доступ к релизу, его нужно опубликовать. Для этого переключитесь на основную ветку, добавьте в репозиторий файл с описанием каналов обновлений [trdl_channels.yaml](/documentation/reference/trdl_channels_yaml.html). #### trdl_channels.yaml: diff --git a/docs/pages_ru/reference/trdl_channels_yaml.md b/docs/pages_ru/documentation/reference/trdl_channels_yaml.md similarity index 88% rename from docs/pages_ru/reference/trdl_channels_yaml.md rename to docs/pages_ru/documentation/reference/trdl_channels_yaml.md index dcc20ccd..b57e719a 100644 --- a/docs/pages_ru/reference/trdl_channels_yaml.md +++ b/docs/pages_ru/documentation/reference/trdl_channels_yaml.md @@ -1,6 +1,6 @@ --- title: trdl_channels.yaml -permalink: reference/trdl_channels_yaml.html +permalink: documentation/reference/trdl_channels_yaml.html toc: false --- @@ -8,7 +8,7 @@ toc: false При публикации trdl читает `trdl_channels.yaml` из ветки Git-репозитория по умолчанию, если это явно не переопределено при конфигурации vault-плагина, а затем применяет изменения. Обновления становятся доступными пользователям. -{% include reference/trdl_channels_yaml/table.html %} +{% include documentation/reference/trdl_channels_yaml/table.html %} ## Пример diff --git a/docs/pages_ru/reference/trdl_yaml.md b/docs/pages_ru/documentation/reference/trdl_yaml.md similarity index 91% rename from docs/pages_ru/reference/trdl_yaml.md rename to docs/pages_ru/documentation/reference/trdl_yaml.md index 343275cd..71f3f002 100644 --- a/docs/pages_ru/reference/trdl_yaml.md +++ b/docs/pages_ru/documentation/reference/trdl_yaml.md @@ -1,6 +1,6 @@ --- title: trdl.yaml -permalink: reference/trdl_yaml.html +permalink: documentation/reference/trdl_yaml.html toc: false --- @@ -12,7 +12,7 @@ toc: false - Выполняет сборочные инструкции в директории `/git`. - Сохраняет артефакты релиза из директории `/result`. -{% include reference/trdl_yaml/table.html %} +{% include documentation/reference/trdl_yaml/table.html %} ## Организация артефактов релиза @@ -58,12 +58,12 @@ result ### trdl.yaml -{% include reference/trdl_yaml/example_trdl_yaml.md.liquid %} +{% include documentation/reference/trdl_yaml/example_trdl_yaml.md.liquid %} ### build.sh -{% include reference/trdl_yaml/example_build_sh.md.liquid %} +{% include documentation/reference/trdl_yaml/example_build_sh.md.liquid %} ### Директория /result после выполнения сборочных инструкций -{% include reference/trdl_yaml/example_result.md.liquid %} +{% include documentation/reference/trdl_yaml/example_result.md.liquid %} diff --git a/docs/pages_ru/reference/tuf_repository_layout.md b/docs/pages_ru/documentation/reference/tuf_repository_layout.md similarity index 97% rename from docs/pages_ru/reference/tuf_repository_layout.md rename to docs/pages_ru/documentation/reference/tuf_repository_layout.md index 8eaafe98..164754cb 100644 --- a/docs/pages_ru/reference/tuf_repository_layout.md +++ b/docs/pages_ru/documentation/reference/tuf_repository_layout.md @@ -1,7 +1,6 @@ --- title: Организация TUF-репозитория -title: Организация TUF-репозитория -permalink: reference/tuf_repository_layout.html +permalink: documentation/reference/tuf_repository_layout.html toc: true --- From d2f9257835552ce5e45f49d74b5e11e284d85dcd Mon Sep 17 00:00:00 2001 From: Alexey Igrychev Date: Mon, 7 Feb 2022 21:22:58 +0000 Subject: [PATCH 03/16] site: update breadcrumbs Signed-off-by: Alexey Igrychev --- docs/_data/breadcrumbs.yml | 54 +++++++++++++++++++++----------------- 1 file changed, 30 insertions(+), 24 deletions(-) diff --git a/docs/_data/breadcrumbs.yml b/docs/_data/breadcrumbs.yml index cb6ffebd..1bf67924 100644 --- a/docs/_data/breadcrumbs.yml +++ b/docs/_data/breadcrumbs.yml @@ -1,44 +1,50 @@ en: - /reference: &reference + /documentation: &documentation + title: Documentation + url: /documentation/reference/cli/overview.html + /documentation/reference: &reference title: Reference - url: /reference/cli/overview.html - /reference/cli: &reference-cli + url: /documentation/reference/cli/overview.html + /documentation/reference/cli: &reference-cli title: Command line interface - url: /reference/cli/overview.html - /reference/vault_plugin: &reference-vault_plugin + url: /documentation/reference/cli/overview.html + /documentation/reference/vault_plugin: &reference-vault_plugin title: Vault plugin - url: /reference/vault_plugin/index.html - /reference/vault_plugin/configure: &reference-vault_plugin_configure + url: /documentation/reference/vault_plugin/index.html + /documentation/reference/vault_plugin/configure: &reference-vault_plugin_configure title: Configure - url: /reference/vault_plugin/configure.html - /reference/vault_plugin/configure/trusted_pgp_public_key: &reference-vault_plugin_configure_trusted_pgp_public_key + url: /documentation/reference/vault_plugin/configure.html + /documentation/reference/vault_plugin/configure/trusted_pgp_public_key: &reference-vault_plugin_configure_trusted_pgp_public_key title: Trusted PGP public key - url: /reference/vault_plugin/configure.html - /reference/vault_plugin/task: &reference-vault_plugin_task + url: /documentation/reference/vault_plugin/configure.html + /documentation/reference/vault_plugin/task: &reference-vault_plugin_task title: Task - url: /reference/vault_plugin/task.html - /reference/vault_plugin/task/uuid: &reference-vault_plugin_task_uuid + url: /documentation/reference/vault_plugin/task.html + /documentation/reference/vault_plugin/task/uuid: &reference-vault_plugin_task_uuid title: UUID - url: /reference/vault_plugin/task/uuid.html - /reference/vault_plugin/trusted_pgp_public_key: &reference-vault_plugin_trusted_pgp_public_key + url: /documentation/reference/vault_plugin/task/uuid.html + /documentation/reference/vault_plugin/trusted_pgp_public_key: &reference-vault_plugin_trusted_pgp_public_key title: Trusted PGP public key - url: /reference/vault_plugin/configure/trusted_pgp_public_key/name.html + url: /documentation/reference/vault_plugin/configure/trusted_pgp_public_key/name.html ru: - /reference: + /documentation: + <<: *documentation + title: Документация + /documentation/reference: << : *reference title: Справочник - /reference/cli: + /documentation/reference/cli: << : *reference-cli title: CLI - /reference/vault_plugin: + /documentation/reference/vault_plugin: << : *reference-vault_plugin - /reference/vault_plugin/configure: + /documentation/reference/vault_plugin/configure: <<: *reference-vault_plugin_configure - /reference/vault_plugin/configure/trusted_pgp_public_key: + /documentation/reference/vault_plugin/configure/trusted_pgp_public_key: <<: *reference-vault_plugin_configure_trusted_pgp_public_key - /reference/vault_plugin/task: + /documentation/reference/vault_plugin/task: <<: *reference-vault_plugin_task - /reference/vault_plugin/task/uuid: + /documentation/reference/vault_plugin/task/uuid: <<: *reference-vault_plugin_task_uuid - /reference/vault_plugin/trusted_pgp_public_key: + /documentation/reference/vault_plugin/trusted_pgp_public_key: <<: *reference-vault_plugin_trusted_pgp_public_key From 30f7c5466e328ed5d7b40377da9b03ef494997c2 Mon Sep 17 00:00:00 2001 From: Alexey Igrychev Date: Tue, 8 Feb 2022 00:57:09 +0000 Subject: [PATCH 04/16] site: documentation sidebar Signed-off-by: Alexey Igrychev --- docs/Makefile | 24 ++++----- docs/_config.yml | 10 ++-- docs/_data/sidebars/_documentation.yml | 42 ++++++++++++++++ docs/_data/sidebars/_reference.yml | 35 ------------- .../{reference.yml => documentation.yml} | 49 +++++++++++-------- 5 files changed, 87 insertions(+), 73 deletions(-) create mode 100644 docs/_data/sidebars/_documentation.yml delete mode 100644 docs/_data/sidebars/_reference.yml rename docs/_data/sidebars/{reference.yml => documentation.yml} (75%) diff --git a/docs/Makefile b/docs/Makefile index d02bd649..7ffa79f2 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -14,20 +14,20 @@ _regen_reference_vault_plugin: _compile: @( \ - reference_sidebar_path="./_data/sidebars/reference.yml" ; \ + documentation_sidebar_path="./_data/sidebars/documentation.yml" ; \ cli_partial_path="./_data/sidebars/_cli.yml" ; \ vault_plugin_partial_path="./_data/sidebars/_vault_plugin.yml" ; \ - reference_partial_path="./_data/sidebars/_reference.yml" ; \ - echo "# This file is generated by the docs/Makefile" > $$reference_sidebar_path ; \ - echo "# DO NOT EDIT!" >> $$reference_sidebar_path ; \ - echo "" >> $$reference_sidebar_path ; \ - echo "# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting." >> $$reference_sidebar_path ; \ - echo "" >> $$reference_sidebar_path ; \ - cat "$$cli_partial_path" >> "$$reference_sidebar_path" ; \ - echo "" >> "$$reference_sidebar_path" ; \ - cat "$$vault_plugin_partial_path" >> "$$reference_sidebar_path" ; \ - echo "" >> "$$reference_sidebar_path" ; \ - cat "$$reference_partial_path" >> "$$reference_sidebar_path" ; \ + documentation_partial_path="./_data/sidebars/_documentation.yml" ; \ + echo "# This file is generated by the docs/Makefile" > $$documentation_sidebar_path ; \ + echo "# DO NOT EDIT!" >> $$documentation_sidebar_path ; \ + echo "" >> $$documentation_sidebar_path ; \ + echo "# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting." >> $$documentation_sidebar_path ; \ + echo "" >> $$documentation_sidebar_path ; \ + cat "$$cli_partial_path" >> "$$documentation_sidebar_path" ; \ + echo "" >> "$$documentation_sidebar_path" ; \ + cat "$$vault_plugin_partial_path" >> "$$documentation_sidebar_path" ; \ + echo "" >> "$$documentation_sidebar_path" ; \ + cat "$$documentation_partial_path" >> "$$documentation_sidebar_path" ; \ ) .PHONY: all regen_reference _regen_reference_cli _regen_reference_vault_plugin _compile diff --git a/docs/_config.yml b/docs/_config.yml index d3c98eb0..734099c0 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -49,22 +49,22 @@ defaults: sitemap_include: true multilang: true - scope: - path: "pages_*/reference" + path: "pages_*/documentation" type: "pages" values: - sidebar: reference + sidebar: documentation - scope: - path: "pages_*/reference/cli" + path: "pages_*/documentation/reference/cli" type: "pages" values: toc: false - scope: - path: "pages_*/reference/vault_plugin/*" + path: "pages_*/documentation/reference/vault_plugin/*" type: "pages" values: toc: true - scope: - path: "pages_*/reference/vault_plugin/index.md" + path: "pages_*/documentation/reference/vault_plugin/index.md" type: "pages" values: toc: false diff --git a/docs/_data/sidebars/_documentation.yml b/docs/_data/sidebars/_documentation.yml new file mode 100644 index 00000000..ed2fbae5 --- /dev/null +++ b/docs/_data/sidebars/_documentation.yml @@ -0,0 +1,42 @@ +entries: + en: + f: + - title: Reference + f: + + - title: Command line interface + f: *cli + + - title: Vault plugin + f: *_vault_plugin + + - &trdl_yaml + title: trdl.yaml + url: /documentation/reference/trdl_yaml.html + + - &trdl_channels_yaml + title: trdl_channels.yaml + url: /documentation/reference/trdl_channels_yaml.html + + - &tuf_repository_layout + title: TUF repository layout + url: /documentation/reference/tuf_repository_layout.html + + ru: + f: + + - title: Reference + f: + + - title: CLI + f: *cli + + - title: Плагин vault + f: *_vault_plugin + + - *trdl_yaml + + - *trdl_channels_yaml + + - <<: *tuf_repository_layout + title: "Организация TUF-репозитория" diff --git a/docs/_data/sidebars/_reference.yml b/docs/_data/sidebars/_reference.yml deleted file mode 100644 index 1ea926f3..00000000 --- a/docs/_data/sidebars/_reference.yml +++ /dev/null @@ -1,35 +0,0 @@ -entries: - en: - f: - - title: Command line interface - f: *cli - - - title: Vault plugin - f: *_vault_plugin - - - &trdl_yaml - title: trdl.yaml - url: /reference/trdl_yaml.html - - - &trdl_channels_yaml - title: trdl_channels.yaml - url: /reference/trdl_channels_yaml.html - - - &tuf_repository_layout - title: TUF repository layout - url: /reference/tuf_repository_layout.html - - ru: - f: - - title: CLI - f: *cli - - - title: Плагин vault - f: *_vault_plugin - - - *trdl_yaml - - - *trdl_channels_yaml - - - <<: *tuf_repository_layout - title: "Организация TUF-репозитория" diff --git a/docs/_data/sidebars/reference.yml b/docs/_data/sidebars/documentation.yml similarity index 75% rename from docs/_data/sidebars/reference.yml rename to docs/_data/sidebars/documentation.yml index 564bddd2..66c513fa 100644 --- a/docs/_data/sidebars/reference.yml +++ b/docs/_data/sidebars/documentation.yml @@ -83,35 +83,42 @@ _vault_plugin: &_vault_plugin entries: en: f: - - title: Command line interface - f: *cli + - title: Reference + f: - - title: Vault plugin - f: *_vault_plugin + - title: Command line interface + f: *cli - - &trdl_yaml - title: trdl.yaml - url: /reference/trdl_yaml.html + - title: Vault plugin + f: *_vault_plugin - - &trdl_channels_yaml - title: trdl_channels.yaml - url: /reference/trdl_channels_yaml.html + - &trdl_yaml + title: trdl.yaml + url: /documentation/reference/trdl_yaml.html - - &tuf_repository_layout - title: TUF repository layout - url: /reference/tuf_repository_layout.html + - &trdl_channels_yaml + title: trdl_channels.yaml + url: /documentation/reference/trdl_channels_yaml.html + + - &tuf_repository_layout + title: TUF repository layout + url: /documentation/reference/tuf_repository_layout.html ru: f: - - title: CLI - f: *cli - - title: Плагин vault - f: *_vault_plugin + - title: Справочник + f: + + - title: CLI + f: *cli + + - title: Плагин vault + f: *_vault_plugin - - *trdl_yaml + - *trdl_yaml - - *trdl_channels_yaml + - *trdl_channels_yaml - - <<: *tuf_repository_layout - title: "Организация TUF-репозитория" + - <<: *tuf_repository_layout + title: "Организация TUF-репозитория" From 77be594195bb415cd41438f0a3e92e68e66ad8da Mon Sep 17 00:00:00 2001 From: Alexey Igrychev Date: Tue, 8 Feb 2022 01:01:07 +0000 Subject: [PATCH 05/16] site: move security page to documentation Signed-off-by: Alexey Igrychev --- docs/_data/sidebars/_documentation.yml | 7 +++++++ docs/_data/sidebars/documentation.yml | 9 ++++++++- .../security_en/components.html | 0 .../{ => documentation}/security_en/intro.html | 0 .../security_en/not-protecting.html | 0 .../{ => documentation}/security_en/provide.html | 0 .../security_en/recommendations.html | 0 .../security_ru/components.html | 0 .../{ => documentation}/security_ru/intro.html | 0 .../security_ru/not-protecting.html | 0 .../{ => documentation}/security_ru/provide.html | 0 .../security_ru/recommendations.html | 0 docs/pages_en/documentation/security.html | 16 ++++++++++++++++ docs/pages_en/security.html | 16 ---------------- docs/pages_ru/documentation/security.html | 16 ++++++++++++++++ docs/pages_ru/security.html | 16 ---------------- 16 files changed, 47 insertions(+), 33 deletions(-) rename docs/_includes/{ => documentation}/security_en/components.html (100%) rename docs/_includes/{ => documentation}/security_en/intro.html (100%) rename docs/_includes/{ => documentation}/security_en/not-protecting.html (100%) rename docs/_includes/{ => documentation}/security_en/provide.html (100%) rename docs/_includes/{ => documentation}/security_en/recommendations.html (100%) rename docs/_includes/{ => documentation}/security_ru/components.html (100%) rename docs/_includes/{ => documentation}/security_ru/intro.html (100%) rename docs/_includes/{ => documentation}/security_ru/not-protecting.html (100%) rename docs/_includes/{ => documentation}/security_ru/provide.html (100%) rename docs/_includes/{ => documentation}/security_ru/recommendations.html (100%) create mode 100644 docs/pages_en/documentation/security.html delete mode 100644 docs/pages_en/security.html create mode 100644 docs/pages_ru/documentation/security.html delete mode 100644 docs/pages_ru/security.html diff --git a/docs/_data/sidebars/_documentation.yml b/docs/_data/sidebars/_documentation.yml index ed2fbae5..a96b020c 100644 --- a/docs/_data/sidebars/_documentation.yml +++ b/docs/_data/sidebars/_documentation.yml @@ -1,6 +1,10 @@ entries: en: f: + - &security + title: Security + url: /documentation/security.html + - title: Reference f: @@ -25,6 +29,9 @@ entries: ru: f: + - <<: *security + title: "Безопасность" + - title: Reference f: diff --git a/docs/_data/sidebars/documentation.yml b/docs/_data/sidebars/documentation.yml index 66c513fa..4aa0339e 100644 --- a/docs/_data/sidebars/documentation.yml +++ b/docs/_data/sidebars/documentation.yml @@ -83,6 +83,10 @@ _vault_plugin: &_vault_plugin entries: en: f: + - &security + title: Security + url: /documentation/security.html + - title: Reference f: @@ -107,7 +111,10 @@ entries: ru: f: - - title: Справочник + - <<: *security + title: "Безопасность" + + - title: Reference f: - title: CLI diff --git a/docs/_includes/security_en/components.html b/docs/_includes/documentation/security_en/components.html similarity index 100% rename from docs/_includes/security_en/components.html rename to docs/_includes/documentation/security_en/components.html diff --git a/docs/_includes/security_en/intro.html b/docs/_includes/documentation/security_en/intro.html similarity index 100% rename from docs/_includes/security_en/intro.html rename to docs/_includes/documentation/security_en/intro.html diff --git a/docs/_includes/security_en/not-protecting.html b/docs/_includes/documentation/security_en/not-protecting.html similarity index 100% rename from docs/_includes/security_en/not-protecting.html rename to docs/_includes/documentation/security_en/not-protecting.html diff --git a/docs/_includes/security_en/provide.html b/docs/_includes/documentation/security_en/provide.html similarity index 100% rename from docs/_includes/security_en/provide.html rename to docs/_includes/documentation/security_en/provide.html diff --git a/docs/_includes/security_en/recommendations.html b/docs/_includes/documentation/security_en/recommendations.html similarity index 100% rename from docs/_includes/security_en/recommendations.html rename to docs/_includes/documentation/security_en/recommendations.html diff --git a/docs/_includes/security_ru/components.html b/docs/_includes/documentation/security_ru/components.html similarity index 100% rename from docs/_includes/security_ru/components.html rename to docs/_includes/documentation/security_ru/components.html diff --git a/docs/_includes/security_ru/intro.html b/docs/_includes/documentation/security_ru/intro.html similarity index 100% rename from docs/_includes/security_ru/intro.html rename to docs/_includes/documentation/security_ru/intro.html diff --git a/docs/_includes/security_ru/not-protecting.html b/docs/_includes/documentation/security_ru/not-protecting.html similarity index 100% rename from docs/_includes/security_ru/not-protecting.html rename to docs/_includes/documentation/security_ru/not-protecting.html diff --git a/docs/_includes/security_ru/provide.html b/docs/_includes/documentation/security_ru/provide.html similarity index 100% rename from docs/_includes/security_ru/provide.html rename to docs/_includes/documentation/security_ru/provide.html diff --git a/docs/_includes/security_ru/recommendations.html b/docs/_includes/documentation/security_ru/recommendations.html similarity index 100% rename from docs/_includes/security_ru/recommendations.html rename to docs/_includes/documentation/security_ru/recommendations.html diff --git a/docs/pages_en/documentation/security.html b/docs/pages_en/documentation/security.html new file mode 100644 index 00000000..3a0e5bbc --- /dev/null +++ b/docs/pages_en/documentation/security.html @@ -0,0 +1,16 @@ +--- +title: Security +permalink: documentation/security.html +layout: main-page +--- + + +{% include documentation/security_en/intro.html %} + +{% include documentation/security_en/components.html %} + +{% include documentation/security_en/provide.html %} + +{% include documentation/security_en/not-protecting.html %} + +{% include documentation/security_en/recommendations.html %} diff --git a/docs/pages_en/security.html b/docs/pages_en/security.html deleted file mode 100644 index 3d2d5b16..00000000 --- a/docs/pages_en/security.html +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Security -permalink: security.html -layout: main-page ---- - - -{% include security_en/intro.html %} - -{% include security_en/components.html %} - -{% include security_en/provide.html %} - -{% include security_en/not-protecting.html %} - -{% include security_en/recommendations.html %} diff --git a/docs/pages_ru/documentation/security.html b/docs/pages_ru/documentation/security.html new file mode 100644 index 00000000..48a11616 --- /dev/null +++ b/docs/pages_ru/documentation/security.html @@ -0,0 +1,16 @@ +--- +title: Безопасность +permalink: documentation/security.html +layout: main-page +--- + + +{% include documentation/security_ru/intro.html %} + +{% include documentation/security_ru/components.html %} + +{% include documentation/security_ru/provide.html %} + +{% include documentation/security_ru/not-protecting.html %} + +{% include documentation/security_ru/recommendations.html %} diff --git a/docs/pages_ru/security.html b/docs/pages_ru/security.html deleted file mode 100644 index 764c4964..00000000 --- a/docs/pages_ru/security.html +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Безопасность -permalink: security.html -layout: main-page ---- - - -{% include security_ru/intro.html %} - -{% include security_ru/components.html %} - -{% include security_ru/provide.html %} - -{% include security_ru/not-protecting.html %} - -{% include security_ru/recommendations.html %} From 4bbc07f0a6164001a456e471af463cb40f8222c6 Mon Sep 17 00:00:00 2001 From: Alexey Igrychev Date: Tue, 8 Feb 2022 01:18:48 +0000 Subject: [PATCH 06/16] site: fix image hrefs Signed-off-by: Alexey Igrychev --- .../documentation/security_en/components.html | 16 ++++++++-------- .../security_en/not-protecting.html | 4 ++-- .../documentation/security_en/provide.html | 8 ++++---- .../documentation/security_ru/components.html | 16 ++++++++-------- .../security_ru/not-protecting.html | 4 ++-- .../documentation/security_ru/provide.html | 8 ++++---- docs/_includes/footer.html | 4 ++-- docs/_includes/index_en/architecture.html | 10 +++++----- docs/_includes/index_en/benefits.html | 8 ++++---- docs/_includes/index_en/whats-problems.html | 6 +++--- docs/_includes/index_ru/architecture.html | 14 +++++++------- docs/_includes/index_ru/benefits.html | 8 ++++---- docs/_includes/index_ru/whats-problems.html | 6 +++--- 13 files changed, 56 insertions(+), 56 deletions(-) diff --git a/docs/_includes/documentation/security_en/components.html b/docs/_includes/documentation/security_en/components.html index bcfb41e0..477f7d0d 100644 --- a/docs/_includes/documentation/security_en/components.html +++ b/docs/_includes/documentation/security_en/components.html @@ -6,7 +6,7 @@
  • - +
    Vault
      @@ -17,7 +17,7 @@ @@ -26,7 +26,7 @@
    • - +
      TUF repository
        @@ -39,7 +39,7 @@ @@ -48,7 +48,7 @@
      • - +
        Git repository
        diff --git a/docs/_includes/index_en/architecture.html b/docs/_includes/index_en/architecture.html index 9b69fcee..2f27c7b5 100644 --- a/docs/_includes/index_en/architecture.html +++ b/docs/_includes/index_en/architecture.html @@ -10,19 +10,19 @@
        • - +

          Builds and publishes software releases.

        • - +

          Monitors for consistency between release channels and releases (example).

        • - +

          Ensures repo security.

          • @@ -37,13 +37,13 @@
          • - +

            Processes application files within the release channels.

          • - +

            Processes files in the TUF repository in a reliable fashion.

            • diff --git a/docs/_includes/index_en/benefits.html b/docs/_includes/index_en/benefits.html index ca40dd3b..189827ff 100644 --- a/docs/_includes/index_en/benefits.html +++ b/docs/_includes/index_en/benefits.html @@ -14,7 +14,7 @@
            • - +
              Release channels instead of software versions

              The user doesn’t have to download specific package versions. Instead, (s)he simply chooses a release channel with the desired compatibility and stability levels: alpha, beta, early access, stable, or rock solid. Via these channels, developers distribute the appropriate release versions. The update frequency is not limited in any way.

              @@ -23,7 +23,7 @@
            • - +
              Publishing releases based in the GPG quorum

              trdl implements the so-called “M of N” mechanism: each Git commit is signed by multiple developers. trdl supports regular Git signatures, or the notes mechanism, to attach any number of GPG signatures to a given commit. In addition, the quorum is used for both tagging (version distribution) and signing trdl.yaml (publishing versions to the release channel).

              @@ -32,7 +32,7 @@
            • - +
              Truly secure delivery

              The trdl security system is based on the TUF repository for storing releases and the Vault plugin (vault-plugin-secrets-trdl) which verifies their authenticity and integrity using a private key.

              @@ -47,7 +47,7 @@
            • - +
              Support for various platforms
                diff --git a/docs/_includes/index_en/whats-problems.html b/docs/_includes/index_en/whats-problems.html index 21b4c49c..6e207995 100644 --- a/docs/_includes/index_en/whats-problems.html +++ b/docs/_includes/index_en/whats-problems.html @@ -6,7 +6,7 @@
                • - +
                  Continuous delivery limitations

                  Continuous delivery via the CI system works well for the SaaS model, that is, for software hosted on cloud servers. At the same time, you would be hard-pressed to find a tool that is as fast at delivering code to user devices.

                  @@ -15,7 +15,7 @@
                • - +
                  Challenges related to implementing a secure delivery

                  You may encounter the following challenges in trying to deliver software securely:

                  @@ -30,7 +30,7 @@
                • - +
                  Package manager limitations

                  There are many package managers, but they all have common drawbacks:

                  diff --git a/docs/_includes/index_ru/architecture.html b/docs/_includes/index_ru/architecture.html index 14ee50c4..88ebbd8e 100644 --- a/docs/_includes/index_ru/architecture.html +++ b/docs/_includes/index_ru/architecture.html @@ -10,25 +10,25 @@
                  • - +

                    Релиз новых версий ПО.

                  • - +

                    Публикация каналов обновлений.

                  • - +

                    Верификация всех операций с помощью кворума GPG-подписей.

                  • - +

                    Непрерывная ротация ключей шифрования и метаданных TUF-репозитория.

                    • @@ -43,19 +43,19 @@
                    • - +

                      Обновление версий ПО через выбранные каналы.

                    • - +

                      Верификация обновлений из доверенного TUF-репозитория.

                    • - +

                      Различные варианты использования и обновления ПО.

                      • diff --git a/docs/_includes/index_ru/benefits.html b/docs/_includes/index_ru/benefits.html index 409994a6..a1d5655a 100644 --- a/docs/_includes/index_ru/benefits.html +++ b/docs/_includes/index_ru/benefits.html @@ -14,7 +14,7 @@
                      • - +
                        Каналы обновления вместо версий ПО

                        @@ -31,7 +31,7 @@

                      • - +
                        Все операции подтверждаются GPG-кворумом

                        В trdl реализован механизм верификации «M of N»: каждый коммит в Git, связанный с релизом или публикацией каналов, должен быть подписан минимальным количеством доверенных GPG-ключей.

                        @@ -40,7 +40,7 @@
                      • - +
                        Действительно безопасная доставка

                        В основе системы безопасности trdl три элемента: TUF-репозиторий, плагин Vault и Git.

                        @@ -55,7 +55,7 @@
                      • - +
                        Кроссплатформенный клиент
                          diff --git a/docs/_includes/index_ru/whats-problems.html b/docs/_includes/index_ru/whats-problems.html index 94a679fe..17e9c643 100644 --- a/docs/_includes/index_ru/whats-problems.html +++ b/docs/_includes/index_ru/whats-problems.html @@ -6,7 +6,7 @@
                          • - +
                            Ограниченность continuous delivery

                            Непрерывная доставка через CI-систему хорошо работает с SaaS-продуктами, то есть на облачных серверах. Но трудно найти инструмент, который так же быстро доставлял бы код на пользовательские устройства.

                            @@ -15,7 +15,7 @@
                          • - +
                            Сложность организации безопасной доставки

                            Почему это сложно:

                            @@ -30,7 +30,7 @@
                          • - +
                            Ограниченность пакетных менеджеров

                            Есть множество пакетных менеджеров, но у всех типичные недостатки:

                            From 0dabd2e395bf6325a4c42be2b95cfb1570a031d5 Mon Sep 17 00:00:00 2001 From: Alexey Igrychev Date: Tue, 8 Feb 2022 01:22:29 +0000 Subject: [PATCH 07/16] site: how it works page Signed-off-by: Alexey Igrychev --- docs/_data/sidebars/_documentation.yml | 7 +++++++ docs/_data/sidebars/documentation.yml | 7 +++++++ .../how_it_works_en}/architecture.html | 0 .../how_it_works_en}/how-work-trdl.html | 0 .../how_it_works_en}/slider-release.html | 0 .../how_it_works_en}/slider.html | 0 .../how_it_works_ru}/architecture.html | 0 .../how_it_works_ru}/how-work-trdl.html | 0 .../how_it_works_ru}/slider-release.html | 0 .../how_it_works_ru}/slider.html | 0 docs/pages_en/documentation/how_it_works.md | 13 +++++++++++++ docs/pages_en/index.html | 8 -------- docs/pages_ru/documentation/how_it_works.md | 13 +++++++++++++ docs/pages_ru/index.html | 8 -------- 14 files changed, 40 insertions(+), 16 deletions(-) rename docs/_includes/{index_en => documentation/how_it_works_en}/architecture.html (100%) rename docs/_includes/{index_en => documentation/how_it_works_en}/how-work-trdl.html (100%) rename docs/_includes/{index_en => documentation/how_it_works_en}/slider-release.html (100%) rename docs/_includes/{index_en => documentation/how_it_works_en}/slider.html (100%) rename docs/_includes/{index_ru => documentation/how_it_works_ru}/architecture.html (100%) rename docs/_includes/{index_ru => documentation/how_it_works_ru}/how-work-trdl.html (100%) rename docs/_includes/{index_ru => documentation/how_it_works_ru}/slider-release.html (100%) rename docs/_includes/{index_ru => documentation/how_it_works_ru}/slider.html (100%) create mode 100644 docs/pages_en/documentation/how_it_works.md create mode 100644 docs/pages_ru/documentation/how_it_works.md diff --git a/docs/_data/sidebars/_documentation.yml b/docs/_data/sidebars/_documentation.yml index a96b020c..020817c1 100644 --- a/docs/_data/sidebars/_documentation.yml +++ b/docs/_data/sidebars/_documentation.yml @@ -1,6 +1,10 @@ entries: en: f: + - &how_it_works + title: How it works + url: /documentation/how_it_works.html + - &security title: Security url: /documentation/security.html @@ -29,6 +33,9 @@ entries: ru: f: + - <<: *how_it_works + title: Как это работает + - <<: *security title: "Безопасность" diff --git a/docs/_data/sidebars/documentation.yml b/docs/_data/sidebars/documentation.yml index 4aa0339e..492be811 100644 --- a/docs/_data/sidebars/documentation.yml +++ b/docs/_data/sidebars/documentation.yml @@ -83,6 +83,10 @@ _vault_plugin: &_vault_plugin entries: en: f: + - &how_it_works + title: How it works + url: /documentation/how_it_works.html + - &security title: Security url: /documentation/security.html @@ -111,6 +115,9 @@ entries: ru: f: + - <<: *how_it_works + title: Как это работает + - <<: *security title: "Безопасность" diff --git a/docs/_includes/index_en/architecture.html b/docs/_includes/documentation/how_it_works_en/architecture.html similarity index 100% rename from docs/_includes/index_en/architecture.html rename to docs/_includes/documentation/how_it_works_en/architecture.html diff --git a/docs/_includes/index_en/how-work-trdl.html b/docs/_includes/documentation/how_it_works_en/how-work-trdl.html similarity index 100% rename from docs/_includes/index_en/how-work-trdl.html rename to docs/_includes/documentation/how_it_works_en/how-work-trdl.html diff --git a/docs/_includes/index_en/slider-release.html b/docs/_includes/documentation/how_it_works_en/slider-release.html similarity index 100% rename from docs/_includes/index_en/slider-release.html rename to docs/_includes/documentation/how_it_works_en/slider-release.html diff --git a/docs/_includes/index_en/slider.html b/docs/_includes/documentation/how_it_works_en/slider.html similarity index 100% rename from docs/_includes/index_en/slider.html rename to docs/_includes/documentation/how_it_works_en/slider.html diff --git a/docs/_includes/index_ru/architecture.html b/docs/_includes/documentation/how_it_works_ru/architecture.html similarity index 100% rename from docs/_includes/index_ru/architecture.html rename to docs/_includes/documentation/how_it_works_ru/architecture.html diff --git a/docs/_includes/index_ru/how-work-trdl.html b/docs/_includes/documentation/how_it_works_ru/how-work-trdl.html similarity index 100% rename from docs/_includes/index_ru/how-work-trdl.html rename to docs/_includes/documentation/how_it_works_ru/how-work-trdl.html diff --git a/docs/_includes/index_ru/slider-release.html b/docs/_includes/documentation/how_it_works_ru/slider-release.html similarity index 100% rename from docs/_includes/index_ru/slider-release.html rename to docs/_includes/documentation/how_it_works_ru/slider-release.html diff --git a/docs/_includes/index_ru/slider.html b/docs/_includes/documentation/how_it_works_ru/slider.html similarity index 100% rename from docs/_includes/index_ru/slider.html rename to docs/_includes/documentation/how_it_works_ru/slider.html diff --git a/docs/pages_en/documentation/how_it_works.md b/docs/pages_en/documentation/how_it_works.md new file mode 100644 index 00000000..69c0c1c0 --- /dev/null +++ b/docs/pages_en/documentation/how_it_works.md @@ -0,0 +1,13 @@ +--- +title: How it works +permalink: /documentation/how_it_works.html +layout: main-page +--- + +{% include documentation/how_it_works_en/architecture.html %} + +{% include documentation/how_it_works_en/how-work-trdl.html %} + +{% include documentation/how_it_works_en/slider-release.html %} + +{% include documentation/how_it_works_en/slider.html %} \ No newline at end of file diff --git a/docs/pages_en/index.html b/docs/pages_en/index.html index a791445c..d4ad654d 100644 --- a/docs/pages_en/index.html +++ b/docs/pages_en/index.html @@ -7,14 +7,6 @@ {% include index_en/intro.html %} -{% include index_en/architecture.html %} - -{% include index_en/how-work-trdl.html %} - -{% include index_en/slider-release.html %} - -{% include index_en/slider.html %} - {% include index_en/benefits.html %} {% include index_en/easy-use.html %} diff --git a/docs/pages_ru/documentation/how_it_works.md b/docs/pages_ru/documentation/how_it_works.md new file mode 100644 index 00000000..5e33b985 --- /dev/null +++ b/docs/pages_ru/documentation/how_it_works.md @@ -0,0 +1,13 @@ +--- +title: Как это работает +permalink: /documentation/how_it_works.html +layout: main-page +--- + +{% include documentation/how_it_works_ru/architecture.html %} + +{% include documentation/how_it_works_ru/how-work-trdl.html %} + +{% include documentation/how_it_works_ru/slider-release.html %} + +{% include documentation/how_it_works_ru/slider.html %} \ No newline at end of file diff --git a/docs/pages_ru/index.html b/docs/pages_ru/index.html index 32788bd1..d0ebb6bd 100644 --- a/docs/pages_ru/index.html +++ b/docs/pages_ru/index.html @@ -7,14 +7,6 @@ {% include index_ru/intro.html %} -{% include index_ru/architecture.html %} - -{% include index_ru/how-work-trdl.html %} - -{% include index_ru/slider-release.html %} - -{% include index_ru/slider.html %} - {% include index_ru/benefits.html %} {% include index_ru/easy-use.html %} From 9fb651ce247d78a6c0cedd2ff11ecaf64df72cf9 Mon Sep 17 00:00:00 2001 From: Alexey Igrychev Date: Tue, 8 Feb 2022 01:32:11 +0000 Subject: [PATCH 08/16] site: update topnave Signed-off-by: Alexey Igrychev --- docs/_data/topnav.yml | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/docs/_data/topnav.yml b/docs/_data/topnav.yml index f74e3079..6019ba75 100644 --- a/docs/_data/topnav.yml +++ b/docs/_data/topnav.yml @@ -1,26 +1,20 @@ topnav: en: - - title: Security - url: /security.html - - title: Quickstart url: /quickstart.html - - title: Reference - url: /reference/cli/overview.html + - title: Documentation + url: /documentation/reference/cli/overview.html - title: GitHub external_url: https://github.com/werf/trdl ru: - - title: Безопасность - url: /security.html - - title: Быстрый старт url: /quickstart.html - - title: Справочник - url: /reference/cli/overview.html + - title: Документация + url: /documentation/reference/cli/overview.html - title: GitHub external_url: https://github.com/werf/trdl From 7bdbfbd072d7177d87e1ce385b28e9480df9ba49 Mon Sep 17 00:00:00 2001 From: Alexey Igrychev Date: Tue, 8 Feb 2022 01:34:12 +0000 Subject: [PATCH 09/16] site: move easy to use block to quickstart Signed-off-by: Alexey Igrychev --- docs/_includes/{index_en => quickstart_en}/easy-use.html | 0 docs/_includes/{index_ru => quickstart_ru}/easy-use.html | 0 docs/pages_en/QUICKSTART.md | 2 ++ docs/pages_en/index.html | 2 -- docs/pages_ru/QUICKSTART.md | 2 ++ docs/pages_ru/index.html | 2 -- 6 files changed, 4 insertions(+), 4 deletions(-) rename docs/_includes/{index_en => quickstart_en}/easy-use.html (100%) rename docs/_includes/{index_ru => quickstart_ru}/easy-use.html (100%) diff --git a/docs/_includes/index_en/easy-use.html b/docs/_includes/quickstart_en/easy-use.html similarity index 100% rename from docs/_includes/index_en/easy-use.html rename to docs/_includes/quickstart_en/easy-use.html diff --git a/docs/_includes/index_ru/easy-use.html b/docs/_includes/quickstart_ru/easy-use.html similarity index 100% rename from docs/_includes/index_ru/easy-use.html rename to docs/_includes/quickstart_ru/easy-use.html diff --git a/docs/pages_en/QUICKSTART.md b/docs/pages_en/QUICKSTART.md index e44209d5..21e31efe 100644 --- a/docs/pages_en/QUICKSTART.md +++ b/docs/pages_en/QUICKSTART.md @@ -6,6 +6,8 @@ toc: true toc_headers: h2 --- +{% include quickstart_en/easy-use.html %} + ## For an administrator > We assume that you are already familiar with Vault and know how to use it, so let us skip the details of setting it up. We also assume that Vault is configured according to the [official documentation](https://learn.hashicorp.com/tutorials/vault/deployment-guide). diff --git a/docs/pages_en/index.html b/docs/pages_en/index.html index d4ad654d..4ceec1af 100644 --- a/docs/pages_en/index.html +++ b/docs/pages_en/index.html @@ -9,8 +9,6 @@ {% include index_en/benefits.html %} -{% include index_en/easy-use.html %} - {% include index_en/whats-problems.html %} {% include index_en/solve-that.html %} \ No newline at end of file diff --git a/docs/pages_ru/QUICKSTART.md b/docs/pages_ru/QUICKSTART.md index f0ca510d..c1912c09 100644 --- a/docs/pages_ru/QUICKSTART.md +++ b/docs/pages_ru/QUICKSTART.md @@ -6,6 +6,8 @@ toc: true toc_headers: h2 --- +{% include quickstart_ru/easy-use.html %} + ## Для администратора > Мы предполагаем, что вы уже знакомы с Vault и умеете его использовать, поэтому опустим подробности его настройки. Будем считать, что Vault настроен согласно [официальной документации](https://learn.hashicorp.com/tutorials/vault/deployment-guide). diff --git a/docs/pages_ru/index.html b/docs/pages_ru/index.html index d0ebb6bd..689c5d68 100644 --- a/docs/pages_ru/index.html +++ b/docs/pages_ru/index.html @@ -9,8 +9,6 @@ {% include index_ru/benefits.html %} -{% include index_ru/easy-use.html %} - {% include index_ru/whats-problems.html %} {% include index_ru/solve-that.html %} \ No newline at end of file From 988fa7fa1daf43aac57383e959dd90456c5ad0cc Mon Sep 17 00:00:00 2001 From: Alexey Igrychev Date: Tue, 8 Feb 2022 01:38:05 +0000 Subject: [PATCH 10/16] site: reorganize main page Signed-off-by: Alexey Igrychev --- docs/pages_en/index.html | 5 ++--- docs/pages_ru/index.html | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/pages_en/index.html b/docs/pages_en/index.html index 4ceec1af..e6085c94 100644 --- a/docs/pages_en/index.html +++ b/docs/pages_en/index.html @@ -4,11 +4,10 @@ layout: main-page --- - {% include index_en/intro.html %} -{% include index_en/benefits.html %} - {% include index_en/whats-problems.html %} +{% include index_en/benefits.html %} + {% include index_en/solve-that.html %} \ No newline at end of file diff --git a/docs/pages_ru/index.html b/docs/pages_ru/index.html index 689c5d68..d63a33f5 100644 --- a/docs/pages_ru/index.html +++ b/docs/pages_ru/index.html @@ -4,11 +4,10 @@ layout: main-page --- - {% include index_ru/intro.html %} -{% include index_ru/benefits.html %} - {% include index_ru/whats-problems.html %} +{% include index_ru/benefits.html %} + {% include index_ru/solve-that.html %} \ No newline at end of file From 4c3400caa41f057fcbc65ab03ab98eebaaa8e027 Mon Sep 17 00:00:00 2001 From: Alexey Igrychev Date: Tue, 8 Feb 2022 16:35:23 +0000 Subject: [PATCH 11/16] site: move quickstart to documentation Signed-off-by: Alexey Igrychev --- docs/_data/sidebars/_documentation.yml | 8 ++++++++ docs/_data/sidebars/documentation.yml | 8 ++++++++ docs/_data/topnav.yml | 4 ---- .../{ => documentation}/quickstart_en/easy-use.html | 0 .../{ => documentation}/quickstart_ru/easy-use.html | 0 docs/pages_en/{ => documentation}/QUICKSTART.md | 4 ++-- docs/pages_ru/{ => documentation}/QUICKSTART.md | 4 ++-- 7 files changed, 20 insertions(+), 8 deletions(-) rename docs/_includes/{ => documentation}/quickstart_en/easy-use.html (100%) rename docs/_includes/{ => documentation}/quickstart_ru/easy-use.html (100%) rename docs/pages_en/{ => documentation}/QUICKSTART.md (99%) rename docs/pages_ru/{ => documentation}/QUICKSTART.md (99%) diff --git a/docs/_data/sidebars/_documentation.yml b/docs/_data/sidebars/_documentation.yml index 020817c1..40e56a46 100644 --- a/docs/_data/sidebars/_documentation.yml +++ b/docs/_data/sidebars/_documentation.yml @@ -1,10 +1,15 @@ entries: en: f: + - &how_it_works title: How it works url: /documentation/how_it_works.html + - &quickstart + title: Quickstart + url: /documentation/quickstart.html + - &security title: Security url: /documentation/security.html @@ -36,6 +41,9 @@ entries: - <<: *how_it_works title: Как это работает + - <<: *quickstart + title: Быстрый старт + - <<: *security title: "Безопасность" diff --git a/docs/_data/sidebars/documentation.yml b/docs/_data/sidebars/documentation.yml index 492be811..f897dc52 100644 --- a/docs/_data/sidebars/documentation.yml +++ b/docs/_data/sidebars/documentation.yml @@ -83,10 +83,15 @@ _vault_plugin: &_vault_plugin entries: en: f: + - &how_it_works title: How it works url: /documentation/how_it_works.html + - &quickstart + title: Quickstart + url: /documentation/quickstart.html + - &security title: Security url: /documentation/security.html @@ -118,6 +123,9 @@ entries: - <<: *how_it_works title: Как это работает + - <<: *quickstart + title: Быстрый старт + - <<: *security title: "Безопасность" diff --git a/docs/_data/topnav.yml b/docs/_data/topnav.yml index 6019ba75..0375d8fc 100644 --- a/docs/_data/topnav.yml +++ b/docs/_data/topnav.yml @@ -1,7 +1,5 @@ topnav: en: - - title: Quickstart - url: /quickstart.html - title: Documentation url: /documentation/reference/cli/overview.html @@ -10,8 +8,6 @@ topnav: external_url: https://github.com/werf/trdl ru: - - title: Быстрый старт - url: /quickstart.html - title: Документация url: /documentation/reference/cli/overview.html diff --git a/docs/_includes/quickstart_en/easy-use.html b/docs/_includes/documentation/quickstart_en/easy-use.html similarity index 100% rename from docs/_includes/quickstart_en/easy-use.html rename to docs/_includes/documentation/quickstart_en/easy-use.html diff --git a/docs/_includes/quickstart_ru/easy-use.html b/docs/_includes/documentation/quickstart_ru/easy-use.html similarity index 100% rename from docs/_includes/quickstart_ru/easy-use.html rename to docs/_includes/documentation/quickstart_ru/easy-use.html diff --git a/docs/pages_en/QUICKSTART.md b/docs/pages_en/documentation/QUICKSTART.md similarity index 99% rename from docs/pages_en/QUICKSTART.md rename to docs/pages_en/documentation/QUICKSTART.md index 21e31efe..d7e55aea 100644 --- a/docs/pages_en/QUICKSTART.md +++ b/docs/pages_en/documentation/QUICKSTART.md @@ -1,12 +1,12 @@ --- title: Quickstart -permalink: quickstart.html +permalink: documentation/quickstart.html layout: page-nosidebar toc: true toc_headers: h2 --- -{% include quickstart_en/easy-use.html %} +{% include documentation/quickstart_en/easy-use.html %} ## For an administrator diff --git a/docs/pages_ru/QUICKSTART.md b/docs/pages_ru/documentation/QUICKSTART.md similarity index 99% rename from docs/pages_ru/QUICKSTART.md rename to docs/pages_ru/documentation/QUICKSTART.md index c1912c09..ea64d0af 100644 --- a/docs/pages_ru/QUICKSTART.md +++ b/docs/pages_ru/documentation/QUICKSTART.md @@ -1,12 +1,12 @@ --- title: Быстрый старт -permalink: quickstart.html +permalink: documentation/quickstart.html layout: page-nosidebar toc: true toc_headers: h2 --- -{% include quickstart_ru/easy-use.html %} +{% include documentation/quickstart_ru/easy-use.html %} ## Для администратора From 1bc4b93869e457b6308bf9eedf0787db28e462fc Mon Sep 17 00:00:00 2001 From: Artem Kosulin Date: Fri, 11 Feb 2022 13:52:19 +0300 Subject: [PATCH 12/16] site: fixed styles on main page Signed-off-by: Alexey Igrychev --- docs/_includes/index_en/intro.html | 11 +++++++---- docs/_includes/index_en/solve-that.html | 13 ++++++++----- docs/_includes/index_ru/intro.html | 11 +++++++---- docs/_includes/index_ru/solve-that.html | 11 +++++++---- docs/css/components/index/_benefits.scss | 2 +- docs/css/components/index/_intro.scss | 12 ++++++++++-- docs/css/components/index/_solve-that.scss | 9 +++++++-- docs/css/components/index/_whats-problems.scss | 4 ++++ docs/css/misc/common.scss | 4 ++++ 9 files changed, 55 insertions(+), 22 deletions(-) diff --git a/docs/_includes/index_en/intro.html b/docs/_includes/index_en/intro.html index 46848214..c8d1d31c 100644 --- a/docs/_includes/index_en/intro.html +++ b/docs/_includes/index_en/intro.html @@ -14,12 +14,15 @@

                            + + + + + + - + -
                            diff --git a/docs/_includes/index_en/solve-that.html b/docs/_includes/index_en/solve-that.html index a3b61e91..44b7774a 100644 --- a/docs/_includes/index_en/solve-that.html +++ b/docs/_includes/index_en/solve-that.html @@ -6,12 +6,15 @@ Consider trdl to solve your problems!
                            - - + + + + + + + + -
                            diff --git a/docs/_includes/index_ru/intro.html b/docs/_includes/index_ru/intro.html index b50dc4f2..dd5784a3 100644 --- a/docs/_includes/index_ru/intro.html +++ b/docs/_includes/index_ru/intro.html @@ -26,12 +26,15 @@

                            - - + + - + + + +
                            diff --git a/docs/_includes/index_ru/solve-that.html b/docs/_includes/index_ru/solve-that.html index 6236ead5..434bce35 100644 --- a/docs/_includes/index_ru/solve-that.html +++ b/docs/_includes/index_ru/solve-that.html @@ -6,12 +6,15 @@ Решите их с помощью trdl!
                            - - + + - + + + +
                            diff --git a/docs/css/components/index/_benefits.scss b/docs/css/components/index/_benefits.scss index e7d45a88..fd904e9a 100644 --- a/docs/css/components/index/_benefits.scss +++ b/docs/css/components/index/_benefits.scss @@ -10,7 +10,7 @@ &__lines { position: absolute; - top: 100px; + top: 70px; right: -500px; z-index: -1; diff --git a/docs/css/components/index/_intro.scss b/docs/css/components/index/_intro.scss index 73fd55d9..9ea7c5df 100644 --- a/docs/css/components/index/_intro.scss +++ b/docs/css/components/index/_intro.scss @@ -39,8 +39,16 @@ align-items: center; } - &__button--gh { + &__link { margin-right: rem(40px); + + &:last-child { + margin-right: 0; + } + } + + &__button--accent { + // margin-right: rem(40px); color: $text-color-title-invert; } @@ -51,7 +59,7 @@ &__lines { position: absolute; bottom: -400px; - right: -370px; + right: -405px; z-index: -1; @include laptop { diff --git a/docs/css/components/index/_solve-that.scss b/docs/css/components/index/_solve-that.scss index f1713fc2..7ad7c959 100644 --- a/docs/css/components/index/_solve-that.scss +++ b/docs/css/components/index/_solve-that.scss @@ -9,6 +9,7 @@ &__container { background: $color-accent; + padding: rem(20px) rem(80px); } &__wrap { @@ -25,13 +26,17 @@ } &__button { - &--gh { + &--accent { background: #fff; - margin-right: rem(40px); + // margin-right: rem(40px); } &--doc { border-color: #fff; + + &:hover { + border-color: transparent; + } } } } \ No newline at end of file diff --git a/docs/css/components/index/_whats-problems.scss b/docs/css/components/index/_whats-problems.scss index 3f53ff73..2079b88d 100644 --- a/docs/css/components/index/_whats-problems.scss +++ b/docs/css/components/index/_whats-problems.scss @@ -1,6 +1,10 @@ .whats-problems { &__section { padding-bottom: rem(100px); + + & .card__pic { + stroke: $color-accent; + } } &__title { diff --git a/docs/css/misc/common.scss b/docs/css/misc/common.scss index 8f3092b1..531e439b 100644 --- a/docs/css/misc/common.scss +++ b/docs/css/misc/common.scss @@ -174,6 +174,10 @@ table { border: 2px solid $color-accent; background: transparent; color: $text-color-accent; + + &:hover { + border-color: transparent; + } } &:hover { From f7289ad9afbda33ba4ee0665de3e520296f57c9a Mon Sep 17 00:00:00 2001 From: Artem Kosulin Date: Mon, 14 Feb 2022 10:35:12 +0300 Subject: [PATCH 13/16] site: fixed quickstart page Signed-off-by: Alexey Igrychev --- .../documentation/quickstart_en/easy-use.html | 6 +++--- .../documentation/quickstart_ru/easy-use.html | 6 +++--- docs/_layouts/sidebar.html | 5 ++++- docs/css/components/index/_easy-use.scss | 14 +------------- docs/css/docs.css | 5 +++++ docs/css/misc/common.scss | 11 +++++++++-- docs/pages_en/documentation/QUICKSTART.md | 6 ++++-- docs/pages_ru/documentation/QUICKSTART.md | 6 ++++-- 8 files changed, 33 insertions(+), 26 deletions(-) diff --git a/docs/_includes/documentation/quickstart_en/easy-use.html b/docs/_includes/documentation/quickstart_en/easy-use.html index 5c468325..82338ca5 100644 --- a/docs/_includes/documentation/quickstart_en/easy-use.html +++ b/docs/_includes/documentation/quickstart_en/easy-use.html @@ -1,5 +1,5 @@
                            -
                            +
                            Easy-to-use
                            @@ -33,13 +33,13 @@
                            -
                            +
                            \ No newline at end of file diff --git a/docs/_includes/documentation/quickstart_ru/easy-use.html b/docs/_includes/documentation/quickstart_ru/easy-use.html index 1a9d09d6..c3742c2c 100644 --- a/docs/_includes/documentation/quickstart_ru/easy-use.html +++ b/docs/_includes/documentation/quickstart_ru/easy-use.html @@ -1,5 +1,5 @@
                            -
                            +
                            Простота использования
                            @@ -33,13 +33,13 @@
                            -
                            +
                            \ No newline at end of file diff --git a/docs/_layouts/sidebar.html b/docs/_layouts/sidebar.html index df27b18f..0442800e 100644 --- a/docs/_layouts/sidebar.html +++ b/docs/_layouts/sidebar.html @@ -12,7 +12,10 @@
                            {%- include sidebar.html %}
                            -
                            +
                            + {%- unless page.toc == false %} + {%- include toc.html %} + {%- endunless %} {{ content }}
                            diff --git a/docs/css/components/index/_easy-use.scss b/docs/css/components/index/_easy-use.scss index 893000cd..979c31d4 100644 --- a/docs/css/components/index/_easy-use.scss +++ b/docs/css/components/index/_easy-use.scss @@ -20,17 +20,16 @@ } &__title { - // padding-bottom: rem(60px); padding-bottom: rem(35px); } &__cols { & .col__item { - // @include montserrat(semi-bold); font-size: rem(14px); line-height: rem(20px); display: block; padding-left: rem(30px); + color: #fff; &::before { content: ''; @@ -44,15 +43,4 @@ } } } - - &__lines { - position: absolute; - top: 450px; - right: -95px; - z-index: -1; - - @include old-display { - display: none; - } - } } \ No newline at end of file diff --git a/docs/css/docs.css b/docs/css/docs.css index 19685955..1380a13c 100644 --- a/docs/css/docs.css +++ b/docs/css/docs.css @@ -98,6 +98,11 @@ padding-left: 20px; } +.layout-sidebar__content.docs { + width: 780px; + padding-left: 20px; +} + /* .layout-sidebar__content .post-content > p { padding: 15px 0; } */ diff --git a/docs/css/misc/common.scss b/docs/css/misc/common.scss index 531e439b..86ee12e1 100644 --- a/docs/css/misc/common.scss +++ b/docs/css/misc/common.scss @@ -57,8 +57,11 @@ html { box-sizing: content-box; background: $color-dark; border-radius: rem(20px); - padding: rem(20px) rem(80px); - min-width: 1200px; + // padding: rem(20px) rem(80px); + // min-width: 1200px; + padding: 0; + min-width: auto; + display: flex; @media screen and (max-width: 1375px) { box-sizing: border-box; @@ -213,4 +216,8 @@ table { td .tippy-content { padding: 4px 8px; font-size: 12px; +} + +.ignore-sidebar { + margin-left: rem(-320px); } \ No newline at end of file diff --git a/docs/pages_en/documentation/QUICKSTART.md b/docs/pages_en/documentation/QUICKSTART.md index d7e55aea..2332104a 100644 --- a/docs/pages_en/documentation/QUICKSTART.md +++ b/docs/pages_en/documentation/QUICKSTART.md @@ -1,12 +1,14 @@ --- title: Quickstart permalink: documentation/quickstart.html -layout: page-nosidebar +layout: sidebar toc: true toc_headers: h2 --- +{%comment%} {% include documentation/quickstart_en/easy-use.html %} +{%endcomment%} ## For an administrator @@ -321,4 +323,4 @@ v0.0.1 trdl-example.ps1 v0.0.1 ``` - + \ No newline at end of file diff --git a/docs/pages_ru/documentation/QUICKSTART.md b/docs/pages_ru/documentation/QUICKSTART.md index ea64d0af..83f7c801 100644 --- a/docs/pages_ru/documentation/QUICKSTART.md +++ b/docs/pages_ru/documentation/QUICKSTART.md @@ -1,12 +1,14 @@ --- title: Быстрый старт permalink: documentation/quickstart.html -layout: page-nosidebar +layout: sidebar toc: true toc_headers: h2 --- +{%comment%} {% include documentation/quickstart_ru/easy-use.html %} +{%endcomment%} ## Для администратора @@ -454,4 +456,4 @@ v0.0.1 trdl-example.ps1 v0.0.1 ``` - + \ No newline at end of file From a8c16d002f2ae2ca77546c89407af8958818e38d Mon Sep 17 00:00:00 2001 From: Artem Kosulin Date: Mon, 14 Feb 2022 14:32:07 +0300 Subject: [PATCH 14/16] site: fixed styles on how it works page Signed-off-by: Alexey Igrychev --- .../how_it_works_en/architecture.html | 2 +- .../how_it_works_en/how-work-trdl.html | 12 ++-- .../how_it_works_en/slider-release.html | 56 ++++++++-------- .../documentation/how_it_works_en/slider.html | 64 +++++++++---------- .../how_it_works_ru/architecture.html | 2 +- .../how_it_works_ru/how-work-trdl.html | 10 ++- .../how_it_works_ru/slider-release.html | 56 ++++++++-------- .../documentation/how_it_works_ru/slider.html | 64 +++++++++---------- docs/css/components/index/_architecture.scss | 29 ++++++--- docs/css/components/index/_slider.scss | 63 +++++++++++------- docs/pages_en/documentation/how_it_works.md | 2 +- docs/pages_ru/documentation/how_it_works.md | 2 +- 12 files changed, 189 insertions(+), 173 deletions(-) diff --git a/docs/_includes/documentation/how_it_works_en/architecture.html b/docs/_includes/documentation/how_it_works_en/architecture.html index 2f27c7b5..5f006ef0 100644 --- a/docs/_includes/documentation/how_it_works_en/architecture.html +++ b/docs/_includes/documentation/how_it_works_en/architecture.html @@ -1,5 +1,5 @@
                            -
                            +
                            Architecture
                            diff --git a/docs/_includes/documentation/how_it_works_en/how-work-trdl.html b/docs/_includes/documentation/how_it_works_en/how-work-trdl.html index 9fa4c5f8..2d2556b8 100644 --- a/docs/_includes/documentation/how_it_works_en/how-work-trdl.html +++ b/docs/_includes/documentation/how_it_works_en/how-work-trdl.html @@ -1,9 +1,7 @@ -
                            -
                            -
                            -
                            How does trdl work?
                            -
                            Let's look at how the project team uses trdl to continuously deliver updates to users. The process in its simplified form involves three main steps: pushing the release to the TUF repository, publishing the release channel, and delivering the release to the user via the published release channel.
                            - -
                            +
                            +
                            +
                            How does trdl work?
                            +
                            Let's look at how the project team uses trdl to continuously deliver updates to users. The process in its simplified form involves three main steps: pushing the release to the TUF repository, publishing the release channel, and delivering the release to the user via the published release channel.
                            +
                            \ No newline at end of file diff --git a/docs/_includes/documentation/how_it_works_en/slider-release.html b/docs/_includes/documentation/how_it_works_en/slider-release.html index cde7bdc0..0a2e944e 100644 --- a/docs/_includes/documentation/how_it_works_en/slider-release.html +++ b/docs/_includes/documentation/how_it_works_en/slider-release.html @@ -1,32 +1,30 @@ -
                            -
                            -
                            Releasing
                            -
                            -
                            -
                            -

                            The developer makes a commit and signs it with a GPG signature.

                            - -
                            -
                            -

                            The project quorum signs the commit with GPG signatures.

                            - -
                            -
                            -

                            The release build process commences. The CI system passes the Git tag to Vault.

                            - -
                            -
                            -

                            Vault checks to see if the Git tag contains the minimum set of allowed GPG signatures. If all the necessary signatures are there, Vault starts the build.

                            - -
                            -
                            -

                            Vault signs the resulting build (artifact). Note that Vault automatically generates keys to sign the build with. Those keys are stored in the Vault storage in encrypted form. No one can access those keys or use them.

                            - -
                            -
                            -

                            The resulting build (along with the metadata) gets pushed to the TUF repository.

                            - -
                            +
                            +
                            Releasing
                            +
                            +
                            +
                            +

                            The developer makes a commit and signs it with a GPG signature.

                            + +
                            +
                            +

                            The project quorum signs the commit with GPG signatures.

                            + +
                            +
                            +

                            The release build process commences. The CI system passes the Git tag to Vault.

                            + +
                            +
                            +

                            Vault checks to see if the Git tag contains the minimum set of allowed GPG signatures. If all the necessary signatures are there, Vault starts the build.

                            + +
                            +
                            +

                            Vault signs the resulting build (artifact). Note that Vault automatically generates keys to sign the build with. Those keys are stored in the Vault storage in encrypted form. No one can access those keys or use them.

                            + +
                            +
                            +

                            The resulting build (along with the metadata) gets pushed to the TUF repository.

                            +
                            diff --git a/docs/_includes/documentation/how_it_works_en/slider.html b/docs/_includes/documentation/how_it_works_en/slider.html index 54a4a1fe..86eaa01c 100644 --- a/docs/_includes/documentation/how_it_works_en/slider.html +++ b/docs/_includes/documentation/how_it_works_en/slider.html @@ -1,36 +1,34 @@ -
                            -
                            -
                            Publishing the channels
                            -
                            -
                            -
                            -

                            The developer makes changes to the release channels in Git and commits them while signing with a GPG signature.

                            - -
                            -
                            -

                            The project quorum signs the commit with GPG signatures.

                            - -
                            -
                            -

                            The channel publishing process begins. The CI system passes the commit to Vault.

                            - -
                            -
                            -

                            Vault checks to see if the commit contains the minimum set of allowed GPG signatures. If all the necessary signatures are there, Vault forwards the release channels to the TUF repository.

                            - -
                            -
                            -

                            Vault signs the updated list of channels and related releases. Note that Vault automatically generates keys to sign the build with. Those keys are stored in the Vault storage in encrypted form. No one can access them.

                            - -
                            -
                            -

                            The updated channels (along with the metadata) get pushed to the TUF repository.

                            - -
                            -
                            -

                            The trdl client pulls the update through the selected release channel. The previous artifact version becomes unavailable to the user.The trdl client pulls the update through the selected release channel. The previous artifact version becomes unavailable to the user.

                            - -
                            +
                            +
                            Publishing the channels
                            +
                            +
                            +
                            +

                            The developer makes changes to the release channels in Git and commits them while signing with a GPG signature.

                            + +
                            +
                            +

                            The project quorum signs the commit with GPG signatures.

                            + +
                            +
                            +

                            The channel publishing process begins. The CI system passes the commit to Vault.

                            + +
                            +
                            +

                            Vault checks to see if the commit contains the minimum set of allowed GPG signatures. If all the necessary signatures are there, Vault forwards the release channels to the TUF repository.

                            + +
                            +
                            +

                            Vault signs the updated list of channels and related releases. Note that Vault automatically generates keys to sign the build with. Those keys are stored in the Vault storage in encrypted form. No one can access them.

                            + +
                            +
                            +

                            The updated channels (along with the metadata) get pushed to the TUF repository.

                            + +
                            +
                            +

                            The trdl client pulls the update through the selected release channel. The previous artifact version becomes unavailable to the user.The trdl client pulls the update through the selected release channel. The previous artifact version becomes unavailable to the user.

                            +
                            diff --git a/docs/_includes/documentation/how_it_works_ru/architecture.html b/docs/_includes/documentation/how_it_works_ru/architecture.html index 88ebbd8e..c29fe7f6 100644 --- a/docs/_includes/documentation/how_it_works_ru/architecture.html +++ b/docs/_includes/documentation/how_it_works_ru/architecture.html @@ -1,5 +1,5 @@
                            -
                            +
                            Архитектура
                            diff --git a/docs/_includes/documentation/how_it_works_ru/how-work-trdl.html b/docs/_includes/documentation/how_it_works_ru/how-work-trdl.html index cfad0a67..b6ec983d 100644 --- a/docs/_includes/documentation/how_it_works_ru/how-work-trdl.html +++ b/docs/_includes/documentation/how_it_works_ru/how-work-trdl.html @@ -1,8 +1,6 @@ -
                            -
                            -
                            -
                            Как работает trdl
                            - -
                            +
                            +
                            +
                            Как работает trdl
                            +
                            diff --git a/docs/_includes/documentation/how_it_works_ru/slider-release.html b/docs/_includes/documentation/how_it_works_ru/slider-release.html index 3244ed89..aac2b3e5 100644 --- a/docs/_includes/documentation/how_it_works_ru/slider-release.html +++ b/docs/_includes/documentation/how_it_works_ru/slider-release.html @@ -1,32 +1,30 @@ -
                            -
                            -
                            Релиз новой версии
                            -
                            -
                            -
                            -

                            Разработчик создает Git-тег с новой версией ПО (v1.0.1) и подписывает его своей GPG-подписью.

                            - -
                            -
                            -

                            Кворум проекта подписывает Git-тег своими GPG-подписями.

                            - -
                            -
                            -

                            Инициируется процесс сборки релиза. Из CI-системы имя Git-тега поступает в Vault.

                            - -
                            -
                            -

                            Vault проверяет, содержит ли Git-тег минимальный набор разрешённых GPG-подписей. Если все необходимые подписи есть, Vault инициирует сборку.

                            - -
                            -
                            -

                            Vault подписывает результат сборки (артефакт). Для подписи используются ключи, которые Vault сам же автоматически генерирует и хранит в зашифрованном виде в своём хранилище. Никто не может получить доступ к этим ключам.

                            - -
                            -
                            -

                            Результат сборки вместе с метаданными загружаются в TUF-репозиторий. Однако клиент продолжает работать со старой версией ПО (v1.0.0) до тех пор, пока новая версия не будет опубликована в выбранном канале обновлений.

                            - -
                            +
                            +
                            Релиз новой версии
                            +
                            +
                            +
                            +

                            Разработчик создает Git-тег с новой версией ПО (v1.0.1) и подписывает его своей GPG-подписью.

                            + +
                            +
                            +

                            Кворум проекта подписывает Git-тег своими GPG-подписями.

                            + +
                            +
                            +

                            Инициируется процесс сборки релиза. Из CI-системы имя Git-тега поступает в Vault.

                            + +
                            +
                            +

                            Vault проверяет, содержит ли Git-тег минимальный набор разрешённых GPG-подписей. Если все необходимые подписи есть, Vault инициирует сборку.

                            + +
                            +
                            +

                            Vault подписывает результат сборки (артефакт). Для подписи используются ключи, которые Vault сам же автоматически генерирует и хранит в зашифрованном виде в своём хранилище. Никто не может получить доступ к этим ключам.

                            + +
                            +
                            +

                            Результат сборки вместе с метаданными загружаются в TUF-репозиторий. Однако клиент продолжает работать со старой версией ПО (v1.0.0) до тех пор, пока новая версия не будет опубликована в выбранном канале обновлений.

                            +
                            diff --git a/docs/_includes/documentation/how_it_works_ru/slider.html b/docs/_includes/documentation/how_it_works_ru/slider.html index b4e10ac2..51e33d4a 100644 --- a/docs/_includes/documentation/how_it_works_ru/slider.html +++ b/docs/_includes/documentation/how_it_works_ru/slider.html @@ -1,36 +1,34 @@ -
                            -
                            -
                            Публикация каналов
                            -
                            -
                            -
                            -

                            Разработчик изменяет конфигурацию каналов обновлений в Git и делает коммит со своей GPG-подписью.

                            - -
                            -
                            -

                            Кворум проекта подписывает коммит своими GPG-подписями.

                            - -
                            -
                            -

                            Инициируется процесс публикации каналов. Из CI-системы коммит поступает в Vault.

                            - -
                            -
                            -

                            Vault проверяет, содержит ли коммит минимальный набор разрешённых GPG-подписей.

                            - -
                            -
                            -

                            Vault подписывает обновленный список каналов и связанных с ними релизов. Для подписи используются ключи, которые Vault сам же автоматически генерирует и хранит в зашифрованном виде в своём хранилище. Никто не может получить доступ к ключам.

                            - -
                            -
                            -

                            Обновленные каналы вместе с метаданными загружаются в TUF-репозиторий.

                            - -
                            -
                            -

                            Канал опубликован. Новая версия ПО становится доступной для клиента, использующего этот канал обновлений.

                            - -
                            +
                            +
                            Публикация каналов
                            +
                            +
                            +
                            +

                            Разработчик изменяет конфигурацию каналов обновлений в Git и делает коммит со своей GPG-подписью.

                            + +
                            +
                            +

                            Кворум проекта подписывает коммит своими GPG-подписями.

                            + +
                            +
                            +

                            Инициируется процесс публикации каналов. Из CI-системы коммит поступает в Vault.

                            + +
                            +
                            +

                            Vault проверяет, содержит ли коммит минимальный набор разрешённых GPG-подписей.

                            + +
                            +
                            +

                            Vault подписывает обновленный список каналов и связанных с ними релизов. Для подписи используются ключи, которые Vault сам же автоматически генерирует и хранит в зашифрованном виде в своём хранилище. Никто не может получить доступ к ключам.

                            + +
                            +
                            +

                            Обновленные каналы вместе с метаданными загружаются в TUF-репозиторий.

                            + +
                            +
                            +

                            Канал опубликован. Новая версия ПО становится доступной для клиента, использующего этот канал обновлений.

                            +
                            diff --git a/docs/css/components/index/_architecture.scss b/docs/css/components/index/_architecture.scss index 6cd4fa90..1fa89406 100644 --- a/docs/css/components/index/_architecture.scss +++ b/docs/css/components/index/_architecture.scss @@ -10,6 +10,7 @@ @media screen and (max-width: 1375px) { background: $color-dark; } + } &__wrap { @@ -29,21 +30,22 @@ &__cols { display: flex; justify-content: space-between; + flex-direction: column; - @include tablets { - flex-direction: column; - } + // @include tablets { + // flex-direction: column; + // } &--item { - width: 45%; - - @include tablets { - width: 100%; + // width: 45%; + width: 100%; - &:first-child { - margin-bottom: 30px; - } + &:first-child { + margin-bottom: 50px; } + // @include tablets { + // width: 100%; + // } } & .col { @@ -71,6 +73,7 @@ display: flex; align-items: center; padding-bottom: rem(30px); + padding-left: 0; & .server__icon { min-width: rem(28px); @@ -88,6 +91,8 @@ font-size: rem(14px); line-height: rem(22px); padding-left: rem(30px); + color: $text-color-title-invert; + margin-top: 0; & a { @include montserrat(regular-italic); @@ -95,6 +100,10 @@ color: $text-color-title-invert; } } + + &::before { + display: none; + } } } } diff --git a/docs/css/components/index/_slider.scss b/docs/css/components/index/_slider.scss index 4a2bd9f8..f0b4c70f 100644 --- a/docs/css/components/index/_slider.scss +++ b/docs/css/components/index/_slider.scss @@ -33,31 +33,41 @@ } } - &__item p { - @include montserrat(semi-bold); - font-size: rem(14px); - line-height: rem(20px); - text-align: center; - margin-bottom: rem(35px); - // tmp - display: flex; - align-items: center; - justify-content: center; - min-height: rem(20px*3); - max-width: 75%; - margin-left: auto; - margin-right: auto; - border-radius: rem(10px); - background: #fff; - padding: rem(20px); - } + &__item { + &.slick-slide { + display: flex; + flex-direction: column; + align-items: center; + } - &__item img { - border-radius: 20px; - width: 80%; - margin: 0 auto; + p { + @include montserrat(semi-bold); + font-size: rem(14px); + line-height: rem(20px); + text-align: center; + margin-bottom: rem(35px); + // tmp + display: flex; + align-items: center; + justify-content: center; + min-height: rem(20px*3); + width: 100%; + max-width: 75%; + margin-left: auto; + margin-right: auto; + border-radius: rem(10px); + background: #fff; + padding: rem(20px); + } + + & img { + border-radius: 20px; + width: 80%; + margin: 0 auto; + } } + &__prev { all: unset; background: $color-bg; @@ -90,6 +100,7 @@ width: rem(21px); height: rem(21px); margin: rem(10px); + padding: 0; cursor: pointer; &:first-child { @@ -141,4 +152,12 @@ width: 100%; height: 100%; } +} + +.docs ul.slider__dots > li { + padding: 0; + + &::before { + display: none; + } } \ No newline at end of file diff --git a/docs/pages_en/documentation/how_it_works.md b/docs/pages_en/documentation/how_it_works.md index 69c0c1c0..91592aa5 100644 --- a/docs/pages_en/documentation/how_it_works.md +++ b/docs/pages_en/documentation/how_it_works.md @@ -1,7 +1,7 @@ --- title: How it works permalink: /documentation/how_it_works.html -layout: main-page +layout: sidebar --- {% include documentation/how_it_works_en/architecture.html %} diff --git a/docs/pages_ru/documentation/how_it_works.md b/docs/pages_ru/documentation/how_it_works.md index 5e33b985..45817975 100644 --- a/docs/pages_ru/documentation/how_it_works.md +++ b/docs/pages_ru/documentation/how_it_works.md @@ -1,7 +1,7 @@ --- title: Как это работает permalink: /documentation/how_it_works.html -layout: main-page +layout: sidebar --- {% include documentation/how_it_works_ru/architecture.html %} From ec58e480e9d6941bfd57fe0b03950db222c0665e Mon Sep 17 00:00:00 2001 From: Artem Kosulin Date: Tue, 15 Feb 2022 00:21:53 +0300 Subject: [PATCH 15/16] site: fixed styles on security page Signed-off-by: Alexey Igrychev --- .../documentation/security_en/components.html | 8 +-- .../documentation/security_en/intro.html | 6 +- .../security_en/not-protecting.html | 60 +++++++++---------- .../documentation/security_en/provide.html | 8 +-- .../security_en/recommendations.html | 42 +++++++------ .../documentation/security_ru/components.html | 6 +- .../documentation/security_ru/intro.html | 6 +- .../security_ru/not-protecting.html | 2 +- .../documentation/security_ru/provide.html | 6 +- .../security_ru/recommendations.html | 2 +- docs/css/components/security/_components.scss | 23 ++++--- docs/css/components/security/_intro.scss | 5 +- .../components/security/_not-protecting.scss | 28 +++++---- docs/css/components/security/_provide.scss | 25 ++++++-- docs/css/misc/common.scss | 6 ++ docs/pages_en/documentation/security.html | 2 +- docs/pages_ru/documentation/security.html | 2 +- 17 files changed, 138 insertions(+), 99 deletions(-) diff --git a/docs/_includes/documentation/security_en/components.html b/docs/_includes/documentation/security_en/components.html index 477f7d0d..7c5bba40 100644 --- a/docs/_includes/documentation/security_en/components.html +++ b/docs/_includes/documentation/security_en/components.html @@ -1,5 +1,5 @@
                            -
                            +
                            trdl components and their roles
                            @@ -11,7 +11,7 @@
                            Vault
                            • Secure encryption key management.
                              • -
                            • A platform for running the trdl server securely. Ensures confidentiality, data integrity and availability, accountability; provides authentication and authorization methods.
                              • +
                            • A platform for running the trdl server securely. Ensures confidentiality, data integrity and availability, accountability; provides authentication and authorization methods.
                          -
                          +
                          diff --git a/docs/_includes/documentation/security_en/intro.html b/docs/_includes/documentation/security_en/intro.html index 58edd60e..82ee1377 100644 --- a/docs/_includes/documentation/security_en/intro.html +++ b/docs/_includes/documentation/security_en/intro.html @@ -1,5 +1,5 @@
                          -
                          +
                          Security @@ -7,13 +7,13 @@

                          trdl is designed to minimize the damage from potential attacks on the release system. The Vault secret manager, the TUF-based repository (The Update Framework), and Git are the three main components that make this possible.

                          -
                          +
                          diff --git a/docs/_includes/documentation/security_en/not-protecting.html b/docs/_includes/documentation/security_en/not-protecting.html index 6835d9ef..9c8bbdec 100644 --- a/docs/_includes/documentation/security_en/not-protecting.html +++ b/docs/_includes/documentation/security_en/not-protecting.html @@ -1,35 +1,33 @@ -
                          -
                          -
                          -
                          What trdl does not protect against
                          -
                          -
                          -
                            -
                          • - - - -

                            - trdl cannot protect you against threats related to physical access to the host where the trdl-client is installed. -

                            -
                            • -
                          -
                          - -
                          -
                            -
                          • - - - -

                            - trdl cannot protect you against human errors, e.g., incorrect GPG signature quorum configuration, improper build instructions, and faulty Vault config. -

                            -
                            • -
                          -
                          +
                          +
                          +
                          What trdl does not protect against
                          +
                          +
                          +
                            +
                          • + + + +

                            + trdl cannot protect you against threats related to physical access to the host where the trdl-client is installed. +

                            +
                            • +
                          +
                          + +
                          +
                            +
                          • + + + +

                            + trdl cannot protect you against human errors, e.g., incorrect GPG signature quorum configuration, improper build instructions, and faulty Vault config. +

                            +
                            • +
                          -
                          +
                          diff --git a/docs/_includes/documentation/security_en/provide.html b/docs/_includes/documentation/security_en/provide.html index 5f35fc27..182de481 100644 --- a/docs/_includes/documentation/security_en/provide.html +++ b/docs/_includes/documentation/security_en/provide.html @@ -1,5 +1,5 @@ -
                          -
                          +
                          +
                          Summary @@ -53,12 +53,12 @@
                          -
                          +
                          diff --git a/docs/_includes/documentation/security_en/recommendations.html b/docs/_includes/documentation/security_en/recommendations.html index b237430e..427a7afb 100644 --- a/docs/_includes/documentation/security_en/recommendations.html +++ b/docs/_includes/documentation/security_en/recommendations.html @@ -1,25 +1,23 @@ -
                          -
                          -
                          -
                          Our recommendations
                          -
                          -
                            -
                            -
                          • Use an external authentication provider instead of the Vault root token.
                            • - -
                          • Set up an NGINX proxy to secure access to Vault by switching to HTTPS and enabling access only to certain Vault endpoints.
                            • - -
                          • Run Docker on the same host as Vault and block outside access to Docker.
                            • - -
                            -
                            -
                          • Do not install any other software on the virtual machine where Vault and the trdl plugin are running.
                            • - -
                          • Use the common and proven methods of protecting the OS/host.
                            • - -
                            -
                          -
                          +
                          +
                          +
                          Our recommendations
                          +
                          +
                            +
                            +
                          • Use an external authentication provider instead of the Vault root token.
                            • + +
                          • Set up an NGINX proxy to secure access to Vault by switching to HTTPS and enabling access only to certain Vault endpoints.
                            • + +
                          • Run Docker on the same host as Vault and block outside access to Docker.
                            • + +
                            +
                            +
                          • Do not install any other software on the virtual machine where Vault and the trdl plugin are running.
                            • + +
                          • Use the common and proven methods of protecting the OS/host.
                            • + +
                            +
                          diff --git a/docs/_includes/documentation/security_ru/components.html b/docs/_includes/documentation/security_ru/components.html index 702f28b6..4eadd101 100644 --- a/docs/_includes/documentation/security_ru/components.html +++ b/docs/_includes/documentation/security_ru/components.html @@ -1,5 +1,5 @@
                          -
                          +
                          Компоненты trdl и их функции
                          @@ -90,13 +90,13 @@
                        -
                        +
                        \ No newline at end of file diff --git a/docs/_includes/documentation/security_ru/intro.html b/docs/_includes/documentation/security_ru/intro.html index 0497d1bf..ad350b82 100644 --- a/docs/_includes/documentation/security_ru/intro.html +++ b/docs/_includes/documentation/security_ru/intro.html @@ -1,18 +1,18 @@
                        -
                        +
                        Безопасность

                        trdl спроектирован так, чтобы минимизировать ущерб от потенциальных атак на систему обновления. Три основных компонента, которые за это отвечают, — менеджер секретов Vault, репозиторий на основе The Update Framework и Git.

                        -
                        +
                        \ No newline at end of file diff --git a/docs/_includes/documentation/security_ru/not-protecting.html b/docs/_includes/documentation/security_ru/not-protecting.html index 2fc443cf..c307286e 100644 --- a/docs/_includes/documentation/security_ru/not-protecting.html +++ b/docs/_includes/documentation/security_ru/not-protecting.html @@ -1,4 +1,4 @@ -
                        +
                        От чего trdl не защищает
                        diff --git a/docs/_includes/documentation/security_ru/provide.html b/docs/_includes/documentation/security_ru/provide.html index 31f4a9bf..ac70e108 100644 --- a/docs/_includes/documentation/security_ru/provide.html +++ b/docs/_includes/documentation/security_ru/provide.html @@ -1,4 +1,4 @@ -
                        +
                        @@ -53,12 +53,12 @@
                        -
                        +
                        \ No newline at end of file diff --git a/docs/_includes/documentation/security_ru/recommendations.html b/docs/_includes/documentation/security_ru/recommendations.html index 33b5e992..97e9d749 100644 --- a/docs/_includes/documentation/security_ru/recommendations.html +++ b/docs/_includes/documentation/security_ru/recommendations.html @@ -1,4 +1,4 @@ -
                        +
                        Наши рекомендации
                        diff --git a/docs/css/components/security/_components.scss b/docs/css/components/security/_components.scss index 39e6a515..ec45adaa 100644 --- a/docs/css/components/security/_components.scss +++ b/docs/css/components/security/_components.scss @@ -11,18 +11,27 @@ } &__grid--list { + grid-template-columns: rem(600px); + // max-width: rem(600px); grid-template-areas: - "gear ." - "gear people" - "gear people" - "shield people" - "shield comp" - "shield comp" - ". comp"; + "gear" + "people" + "shield" + "comp"; & .card { display: flex; flex-direction: column; + padding: rem(40px) rem(60px); + + &:nth-child(even) { + margin-right: rem(-180px); + margin-left: rem(180px); + } + + &__item { + padding-left: 0; + } &--gear { & .card__list { diff --git a/docs/css/components/security/_intro.scss b/docs/css/components/security/_intro.scss index 0812ad37..29896409 100644 --- a/docs/css/components/security/_intro.scss +++ b/docs/css/components/security/_intro.scss @@ -2,7 +2,6 @@ &.solve-that { &__section { position: relative; - margin-top: rem(190px); margin-bottom: rem(140px); z-index: 0; @@ -10,6 +9,10 @@ background: $color-accent; margin-top: rem(70px); } + + & .solve-that__container { + padding: 0; + } } } diff --git a/docs/css/components/security/_not-protecting.scss b/docs/css/components/security/_not-protecting.scss index 608d3b6d..7b920238 100644 --- a/docs/css/components/security/_not-protecting.scss +++ b/docs/css/components/security/_not-protecting.scss @@ -1,15 +1,23 @@ .security { - & .architecture__cols { - &--item { - & .col__item .warning { - stroke: $color-accent; + &.how-work__section { + & .architecture__cols { + &--item { + & .col__item { + & .warning { + stroke: $color-accent; + } + + & p { + color: #000; + } + } + + // &:last-child { + // & .col__item { + // max-width: 95%; + // } + // } } - - // &:last-child { - // & .col__item { - // max-width: 95%; - // } - // } } } } \ No newline at end of file diff --git a/docs/css/components/security/_provide.scss b/docs/css/components/security/_provide.scss index 3d3e54cf..07ab31c6 100644 --- a/docs/css/components/security/_provide.scss +++ b/docs/css/components/security/_provide.scss @@ -1,14 +1,26 @@ .security { - & .container--wide { - position: relative; + &.architecture__section { + &.ignore-sidebar { + margin-left: rem(-400px); + margin-right: rem(-80px); + } - @media screen and (max-width: 1375px) { - position: unset; + & .container--wide { + position: relative; + padding: rem(20px) rem(80px); + + @media screen and (max-width: 1375px) { + position: unset; + } } } + .architecture { &__wrap { + margin-left: 0; + margin-right: 0; + & .col__text { @include montserrat(regular); font-size: rem(18px); @@ -29,6 +41,10 @@ } &__cols--item { + &:first-child { + margin-bottom: 0; + } + & .warning { fill: none; stroke: $text-color-title-invert-light; @@ -40,6 +56,7 @@ } &__cols { + flex-direction: row; margin-bottom: rem(30px); & .col { diff --git a/docs/css/misc/common.scss b/docs/css/misc/common.scss index 86ee12e1..d158675a 100644 --- a/docs/css/misc/common.scss +++ b/docs/css/misc/common.scss @@ -220,4 +220,10 @@ td .tippy-content { .ignore-sidebar { margin-left: rem(-320px); +} + +.docs .security ul > li { + &::before { + display: none; + } } \ No newline at end of file diff --git a/docs/pages_en/documentation/security.html b/docs/pages_en/documentation/security.html index 3a0e5bbc..2d732b48 100644 --- a/docs/pages_en/documentation/security.html +++ b/docs/pages_en/documentation/security.html @@ -1,7 +1,7 @@ --- title: Security permalink: documentation/security.html -layout: main-page +layout: sidebar --- diff --git a/docs/pages_ru/documentation/security.html b/docs/pages_ru/documentation/security.html index 48a11616..8cc8e28b 100644 --- a/docs/pages_ru/documentation/security.html +++ b/docs/pages_ru/documentation/security.html @@ -1,7 +1,7 @@ --- title: Безопасность permalink: documentation/security.html -layout: main-page +layout: sidebar --- From 9339789535d0a28858da2db926b5df2e7abb87e4 Mon Sep 17 00:00:00 2001 From: Artem Kosulin Date: Tue, 15 Feb 2022 17:24:34 +0300 Subject: [PATCH 16/16] site: fixed menu item selection Signed-off-by: Alexey Igrychev --- docs/_includes/topnav.html | 7 +++++++ docs/css/components/_header.scss | 4 ++++ 2 files changed, 11 insertions(+) diff --git a/docs/_includes/topnav.html b/docs/_includes/topnav.html index 7aed3e21..b126c482 100644 --- a/docs/_includes/topnav.html +++ b/docs/_includes/topnav.html @@ -45,7 +45,14 @@ {%- if folder.url.size>1 and page.url != folder.url and page.url contains folder.url and page.url != '/installation.html' %} header__menu--item_active{% endif %} {%- if folder.url.size<2 and page.url.size<2 %} header__menu--item_active{% endif %} + {%- comment -%} {%- if folder.title == 'Документация' or folder.title == 'Documentation' %} header__menu--item_active{% endif %}"> + {%- endcomment -%} + {%- if (folder.title == 'Документация' or folder.title == 'Documentation') %} + {%- if page.url contains 'documentation' %} + header__menu--item_active + {% endif %} + {% endif %}"> {% capture folder_url %} {%- if folder.external_url -%} {{- folder.external_url -}} diff --git a/docs/css/components/_header.scss b/docs/css/components/_header.scss index e78016f8..889e81b3 100644 --- a/docs/css/components/_header.scss +++ b/docs/css/components/_header.scss @@ -51,6 +51,10 @@ display: none; } + &:last-child { + padding-right: 0; + } + @include tablets { padding-bottom: 30px;