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..7ffa79f2 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -10,24 +10,24 @@ _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: @( \ - 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/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 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/_documentation.yml b/docs/_data/sidebars/_documentation.yml new file mode 100644 index 00000000..40e56a46 --- /dev/null +++ b/docs/_data/sidebars/_documentation.yml @@ -0,0 +1,64 @@ +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 + + - 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: + + - <<: *how_it_works + title: Как это работает + + - <<: *quickstart + title: Быстрый старт + + - <<: *security + title: "Безопасность" + + - 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/_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/documentation.yml b/docs/_data/sidebars/documentation.yml new file mode 100644 index 00000000..f897dc52 --- /dev/null +++ b/docs/_data/sidebars/documentation.yml @@ -0,0 +1,146 @@ +# This file is generated by the docs/Makefile +# DO NOT EDIT! + +# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting. + +# This file is generated by "trdl docs" command. +# DO NOT EDIT! + +cli: &cli + + - title: Overview + url: /documentation/reference/cli/overview.html + + - title: Configuration commands + f: + + - title: trdl add + url: /documentation/reference/cli/trdl_add.html + + - title: trdl remove + url: /documentation/reference/cli/trdl_remove.html + + - title: trdl list + url: /documentation/reference/cli/trdl_list.html + + - title: trdl set-default-channel + url: /documentation/reference/cli/trdl_set_default_channel.html + + - title: Main commands + f: + + - title: trdl use + url: /documentation/reference/cli/trdl_use.html + + - title: Advanced commands + f: + + - title: trdl update + url: /documentation/reference/cli/trdl_update.html + + - title: trdl exec + url: /documentation/reference/cli/trdl_exec.html + + - title: trdl dir-path + url: /documentation/reference/cli/trdl_dir_path.html + + - title: trdl bin-path + 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: /documentation/reference/vault_plugin/index.html + - title: Paths + f: + - title: /configure + url: /documentation/reference/vault_plugin/configure.html + - title: /configure/git_credential + url: /documentation/reference/vault_plugin/configure/git_credential.html + - title: /configure/pgp_signing_key + url: /documentation/reference/vault_plugin/configure/pgp_signing_key.html + - title: /configure/trusted_pgp_public_key + url: /documentation/reference/vault_plugin/configure/trusted_pgp_public_key.html + - title: /configure/trusted_pgp_public_key/:name + url: /documentation/reference/vault_plugin/configure/trusted_pgp_public_key/name.html + - title: /publish + url: /documentation/reference/vault_plugin/publish.html + - title: /release + url: /documentation/reference/vault_plugin/release.html + - title: /task + url: /documentation/reference/vault_plugin/task.html + - title: /task/configure + url: /documentation/reference/vault_plugin/task/configure.html + - title: /task/:uuid + url: /documentation/reference/vault_plugin/task/uuid.html + - title: /task/:uuid/cancel + url: /documentation/reference/vault_plugin/task/uuid/cancel.html + - title: /task/:uuid/log + url: /documentation/reference/vault_plugin/task/uuid/log.html + +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 + + - 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: + + - <<: *how_it_works + title: Как это работает + + - <<: *quickstart + title: Быстрый старт + + - <<: *security + title: "Безопасность" + + - 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 e4a35081..00000000 --- a/docs/_data/sidebars/reference.yml +++ /dev/null @@ -1,117 +0,0 @@ -# This file is generated by the docs/Makefile -# DO NOT EDIT! - -# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting. - -# This file is generated by "trdl docs" command. -# DO NOT EDIT! - -cli: &cli - - - title: Overview - url: /reference/cli/overview.html - - - title: Configuration commands - f: - - - title: trdl add - url: /reference/cli/trdl_add.html - - - title: trdl remove - url: /reference/cli/trdl_remove.html - - - title: trdl list - url: /reference/cli/trdl_list.html - - - title: trdl set-default-channel - url: /reference/cli/trdl_set_default_channel.html - - - title: Main commands - f: - - - title: trdl use - url: /reference/cli/trdl_use.html - - - title: Advanced commands - f: - - - title: trdl update - url: /reference/cli/trdl_update.html - - - title: trdl exec - url: /reference/cli/trdl_exec.html - - - title: trdl dir-path - url: /reference/cli/trdl_dir_path.html - - - title: trdl bin-path - url: /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 - - title: Paths - f: - - title: /configure - url: /reference/vault_plugin/configure.html - - title: /configure/git_credential - url: /reference/vault_plugin/configure/git_credential.html - - title: /configure/pgp_signing_key - url: /reference/vault_plugin/configure/pgp_signing_key.html - - title: /configure/trusted_pgp_public_key - url: /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 - - title: /publish - url: /reference/vault_plugin/publish.html - - title: /release - url: /reference/vault_plugin/release.html - - title: /task - url: /reference/vault_plugin/task.html - - title: /task/configure - url: /reference/vault_plugin/task/configure.html - - title: /task/:uuid - url: /reference/vault_plugin/task/uuid.html - - title: /task/:uuid/cancel - url: /reference/vault_plugin/task/uuid/cancel.html - - title: /task/:uuid/log - url: /reference/vault_plugin/task/uuid/log.html - -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/topnav.yml b/docs/_data/topnav.yml index f74e3079..0375d8fc 100644 --- a/docs/_data/topnav.yml +++ b/docs/_data/topnav.yml @@ -1,26 +1,16 @@ 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 diff --git a/docs/_includes/index_en/architecture.html b/docs/_includes/documentation/how_it_works_en/architecture.html similarity index 83% rename from docs/_includes/index_en/architecture.html rename to docs/_includes/documentation/how_it_works_en/architecture.html index 9b69fcee..5f006ef0 100644 --- a/docs/_includes/index_en/architecture.html +++ b/docs/_includes/documentation/how_it_works_en/architecture.html @@ -1,5 +1,5 @@
-
+
Architecture
@@ -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/documentation/how_it_works_en/how-work-trdl.html b/docs/_includes/documentation/how_it_works_en/how-work-trdl.html new file mode 100644 index 00000000..2d2556b8 --- /dev/null +++ b/docs/_includes/documentation/how_it_works_en/how-work-trdl.html @@ -0,0 +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.
      + +
      +
      \ 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 new file mode 100644 index 00000000..0a2e944e --- /dev/null +++ b/docs/_includes/documentation/how_it_works_en/slider-release.html @@ -0,0 +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.

      + +
      +
      +
      diff --git a/docs/_includes/documentation/how_it_works_en/slider.html b/docs/_includes/documentation/how_it_works_en/slider.html new file mode 100644 index 00000000..86eaa01c --- /dev/null +++ b/docs/_includes/documentation/how_it_works_en/slider.html @@ -0,0 +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.

      + +
      +
      +
      diff --git a/docs/_includes/index_ru/architecture.html b/docs/_includes/documentation/how_it_works_ru/architecture.html similarity index 83% rename from docs/_includes/index_ru/architecture.html rename to docs/_includes/documentation/how_it_works_ru/architecture.html index 14ee50c4..c29fe7f6 100644 --- a/docs/_includes/index_ru/architecture.html +++ b/docs/_includes/documentation/how_it_works_ru/architecture.html @@ -1,5 +1,5 @@
      -
      +
      Архитектура
      @@ -10,25 +10,25 @@
      • - +

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

      • - +

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

      • - +

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

      • - +

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

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

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

        • - +

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

        • - +

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

          • 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 new file mode 100644 index 00000000..b6ec983d --- /dev/null +++ b/docs/_includes/documentation/how_it_works_ru/how-work-trdl.html @@ -0,0 +1,6 @@ +
          +
          +
          Как работает 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 new file mode 100644 index 00000000..aac2b3e5 --- /dev/null +++ b/docs/_includes/documentation/how_it_works_ru/slider-release.html @@ -0,0 +1,30 @@ +
          +
          Релиз новой версии
          +
          +
          +
          +

          Разработчик создает 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 new file mode 100644 index 00000000..51e33d4a --- /dev/null +++ b/docs/_includes/documentation/how_it_works_ru/slider.html @@ -0,0 +1,34 @@ +
          +
          Публикация каналов
          +
          +
          +
          +

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

          + +
          +
          +

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

          + +
          +
          +

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

          + +
          +
          +

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

          + +
          +
          +

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

          + +
          +
          +

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

          + +
          +
          +

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

          + +
          +
          +
          diff --git a/docs/_includes/index_en/easy-use.html b/docs/_includes/documentation/quickstart_en/easy-use.html similarity index 96% rename from docs/_includes/index_en/easy-use.html rename to docs/_includes/documentation/quickstart_en/easy-use.html index 5c468325..82338ca5 100644 --- a/docs/_includes/index_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/index_ru/easy-use.html b/docs/_includes/documentation/quickstart_ru/easy-use.html similarity index 97% rename from docs/_includes/index_ru/easy-use.html rename to docs/_includes/documentation/quickstart_ru/easy-use.html index 1a9d09d6..c3742c2c 100644 --- a/docs/_includes/index_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/_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/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/_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/security_en/components.html b/docs/_includes/documentation/security_en/components.html similarity index 83% rename from docs/_includes/security_en/components.html rename to docs/_includes/documentation/security_en/components.html index bcfb41e0..7c5bba40 100644 --- a/docs/_includes/security_en/components.html +++ b/docs/_includes/documentation/security_en/components.html @@ -1,23 +1,23 @@
      -
      +
      trdl components and their roles
      • - +
        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.
        @@ -26,7 +26,7 @@
      • - +
        TUF repository
          @@ -39,7 +39,7 @@ @@ -48,7 +48,7 @@
        • - +
          Git repository
      diff --git a/docs/_includes/security_en/intro.html b/docs/_includes/documentation/security_en/intro.html similarity index 90% rename from docs/_includes/security_en/intro.html rename to docs/_includes/documentation/security_en/intro.html index 58edd60e..82ee1377 100644 --- a/docs/_includes/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 new file mode 100644 index 00000000..9c8bbdec --- /dev/null +++ b/docs/_includes/documentation/security_en/not-protecting.html @@ -0,0 +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. +

        +
        • +
      +
      +
      + +
      +
      diff --git a/docs/_includes/security_en/provide.html b/docs/_includes/documentation/security_en/provide.html similarity index 86% rename from docs/_includes/security_en/provide.html rename to docs/_includes/documentation/security_en/provide.html index ec8cb452..182de481 100644 --- a/docs/_includes/security_en/provide.html +++ b/docs/_includes/documentation/security_en/provide.html @@ -1,5 +1,5 @@ -
      -
      +
      +
      Summary @@ -12,7 +12,7 @@
      • - +

        It protects against Git repository spoofing and compromise. trdl uses Git commits to ensure the integrity of the entire change history, including all metadata and repository content, all the way back to the initial commit. @@ -20,7 +20,7 @@

      • - +

        All operations are confirmed by a quorum of GPG signatures for each commit. The signatures are stored in the Git repository, while the public parts of trusted GPG keys and the list of required signatures are stored in Vault. @@ -34,7 +34,7 @@

        • - +

          trdl protects against rolling back the release channels to previous versions with vulnerabilities. During the update, trdl checks if the last successful commit is related to the current one. As a result, git push --force to a prior signed commit will not work. @@ -42,7 +42,7 @@

        • - +

          trdl manages encryption keys and automatically creates and stores them in Vault. As a result, no one has access to the encryption keys, and no one ever uses them directly. @@ -53,12 +53,12 @@

      -
      +
      diff --git a/docs/_includes/documentation/security_en/recommendations.html b/docs/_includes/documentation/security_en/recommendations.html new file mode 100644 index 00000000..427a7afb --- /dev/null +++ b/docs/_includes/documentation/security_en/recommendations.html @@ -0,0 +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.
        • + +
        +
      +
      +
      +
      diff --git a/docs/_includes/security_ru/components.html b/docs/_includes/documentation/security_ru/components.html similarity index 87% rename from docs/_includes/security_ru/components.html rename to docs/_includes/documentation/security_ru/components.html index a5fc55b0..4eadd101 100644 --- a/docs/_includes/security_ru/components.html +++ b/docs/_includes/documentation/security_ru/components.html @@ -1,12 +1,12 @@
      -
      +
      Компоненты trdl и их функции
      • - +
        Vault
          @@ -17,7 +17,7 @@ @@ -26,7 +26,7 @@
        • - +
          TUF-репозиторий
            @@ -39,7 +39,7 @@ @@ -48,7 +48,7 @@
          • - +
            Git-репозиторий
      \ No newline at end of file diff --git a/docs/_includes/security_ru/intro.html b/docs/_includes/documentation/security_ru/intro.html similarity index 91% rename from docs/_includes/security_ru/intro.html rename to docs/_includes/documentation/security_ru/intro.html index 0497d1bf..ad350b82 100644 --- a/docs/_includes/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/security_ru/not-protecting.html b/docs/_includes/documentation/security_ru/not-protecting.html similarity index 86% rename from docs/_includes/security_ru/not-protecting.html rename to docs/_includes/documentation/security_ru/not-protecting.html index 5488b5ba..c307286e 100644 --- a/docs/_includes/security_ru/not-protecting.html +++ b/docs/_includes/documentation/security_ru/not-protecting.html @@ -1,4 +1,4 @@ -
      +
      От чего trdl не защищает
      @@ -7,7 +7,7 @@
      • - +

        От угроз, связанных с физическим доступом к хосту, на котором установлен trdl-клиент. @@ -20,7 +20,7 @@

        • - +

          От ошибок, связанных с человеческим фактором, в частности — некорректной настройки кворума GPG-подписей, сборочных инструкций, самого Vault. diff --git a/docs/_includes/security_ru/provide.html b/docs/_includes/documentation/security_ru/provide.html similarity index 89% rename from docs/_includes/security_ru/provide.html rename to docs/_includes/documentation/security_ru/provide.html index dea9a6cd..ac70e108 100644 --- a/docs/_includes/security_ru/provide.html +++ b/docs/_includes/documentation/security_ru/provide.html @@ -1,4 +1,4 @@ -

          +
          @@ -12,7 +12,7 @@
          • - +

            Система защищает от подмены и компрометации Git-репозитория. Контроль основывается на Git-коммитах, что обеспечивает гарантию целостности всей истории изменений, включая все метаданные и содержимое хранилища, вплоть до начального коммита. @@ -20,7 +20,7 @@

          • - +

            Все операции подтверждаются кворумом GPG-подписей у коммита. Подписи хранятся в Git-репозитории, публичные части допустимых GPG-ключей и минимальный набор подписей — в Vault. @@ -34,7 +34,7 @@

            • - +

              Система защищает от отката каналов обновлений на предыдущие версии с уязвимостями. При обновлении система проверяет родство коммита последней успешной публикации с текущим. Поэтому git push --force на предыдущий подписанный коммит ни к чему не приведёт. @@ -42,7 +42,7 @@

            • - +

              Система управляет ключами шифрования, автоматически создаёт и хранит их в Vault. Ни у кого нет доступа к ключам шифрования, никто не работает с ними. @@ -53,12 +53,12 @@

          -
          +
          \ No newline at end of file diff --git a/docs/_includes/security_ru/recommendations.html b/docs/_includes/documentation/security_ru/recommendations.html similarity index 96% rename from docs/_includes/security_ru/recommendations.html rename to docs/_includes/documentation/security_ru/recommendations.html index 33b5e992..97e9d749 100644 --- a/docs/_includes/security_ru/recommendations.html +++ b/docs/_includes/documentation/security_ru/recommendations.html @@ -1,4 +1,4 @@ -
          +
          Наши рекомендации
          diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html index 9a587baa..d541308c 100644 --- a/docs/_includes/footer.html +++ b/docs/_includes/footer.html @@ -14,12 +14,12 @@
          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/how-work-trdl.html b/docs/_includes/index_en/how-work-trdl.html deleted file mode 100644 index 9fa4c5f8..00000000 --- a/docs/_includes/index_en/how-work-trdl.html +++ /dev/null @@ -1,9 +0,0 @@ -
              -
              -
              -
              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/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/slider-release.html b/docs/_includes/index_en/slider-release.html deleted file mode 100644 index cde7bdc0..00000000 --- a/docs/_includes/index_en/slider-release.html +++ /dev/null @@ -1,32 +0,0 @@ -
          -
          -
          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/index_en/slider.html b/docs/_includes/index_en/slider.html deleted file mode 100644 index 54a4a1fe..00000000 --- a/docs/_includes/index_en/slider.html +++ /dev/null @@ -1,36 +0,0 @@ -
          -
          -
          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/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_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/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/how-work-trdl.html b/docs/_includes/index_ru/how-work-trdl.html deleted file mode 100644 index cfad0a67..00000000 --- a/docs/_includes/index_ru/how-work-trdl.html +++ /dev/null @@ -1,8 +0,0 @@ -
            -
            -
            -
            Как работает trdl
            - -
            -
            -
            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/slider-release.html b/docs/_includes/index_ru/slider-release.html deleted file mode 100644 index 3244ed89..00000000 --- a/docs/_includes/index_ru/slider-release.html +++ /dev/null @@ -1,32 +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/index_ru/slider.html b/docs/_includes/index_ru/slider.html deleted file mode 100644 index b4e10ac2..00000000 --- a/docs/_includes/index_ru/slider.html +++ /dev/null @@ -1,36 +0,0 @@ -
      -
      -
      Публикация каналов
      -
      -
      -
      -

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

      - -
      -
      -

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

      - -
      -
      -

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

      - -
      -
      -

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

      - -
      -
      -

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

      - -
      -
      -

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

      - -
      -
      -

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

      - -
      -
      -
      -
      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/_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 @@
+ \ 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 new file mode 100644 index 00000000..91592aa5 --- /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: sidebar +--- + +{% 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/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/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 82% rename from docs/pages_en/reference/trdl_yaml.md rename to docs/pages_en/documentation/reference/trdl_yaml.md index 6fe575fe..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 @@ -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: ``` @@ -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_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/documentation/security.html b/docs/pages_en/documentation/security.html new file mode 100644 index 00000000..2d732b48 --- /dev/null +++ b/docs/pages_en/documentation/security.html @@ -0,0 +1,16 @@ +--- +title: Security +permalink: documentation/security.html +layout: sidebar +--- + + +{% 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/index.html b/docs/pages_en/index.html index a791445c..e6085c94 100644 --- a/docs/pages_en/index.html +++ b/docs/pages_en/index.html @@ -4,21 +4,10 @@ layout: main-page --- - {% 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/whats-problems.html %} {% 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_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/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_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/QUICKSTART.md b/docs/pages_ru/documentation/QUICKSTART.md similarity index 93% rename from docs/pages_ru/QUICKSTART.md rename to docs/pages_ru/documentation/QUICKSTART.md index 684c51df..83f7c801 100644 --- a/docs/pages_ru/QUICKSTART.md +++ b/docs/pages_ru/documentation/QUICKSTART.md @@ -1,11 +1,15 @@ --- title: Быстрый старт -permalink: quickstart.html -layout: page-nosidebar +permalink: documentation/quickstart.html +layout: sidebar toc: true toc_headers: h2 --- +{%comment%} +{% include documentation/quickstart_ru/easy-use.html %} +{%endcomment%} + ## Для администратора > Мы предполагаем, что вы уже знакомы с Vault и умеете его использовать, поэтому опустим подробности его настройки. Будем считать, что Vault настроен согласно [официальной документации](https://learn.hashicorp.com/tutorials/vault/deployment-guide). @@ -65,7 +69,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 +94,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). **Добавление ключа** @@ -299,17 +303,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. @@ -337,7 +341,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) репозитория проекта. @@ -351,7 +355,7 @@ git signatures push ### Публикация каналов обновлений -Чтобы у пользователя был доступ к релизу, его нужно опубликовать. Для этого переключитесь на основную ветку, добавьте в репозиторий файл с описанием каналов обновлений [trdl_channels.yaml](/reference/trdl_channels_yaml.html). +Чтобы у пользователя был доступ к релизу, его нужно опубликовать. Для этого переключитесь на основную ветку, добавьте в репозиторий файл с описанием каналов обновлений [trdl_channels.yaml](/documentation/reference/trdl_channels_yaml.html). #### trdl_channels.yaml: @@ -386,7 +390,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) репозитория проекта. @@ -452,4 +456,4 @@ v0.0.1 trdl-example.ps1 v0.0.1 ``` - + \ No newline at end of file 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..45817975 --- /dev/null +++ b/docs/pages_ru/documentation/how_it_works.md @@ -0,0 +1,13 @@ +--- +title: Как это работает +permalink: /documentation/how_it_works.html +layout: sidebar +--- + +{% 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/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/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 86% rename from docs/pages_ru/reference/trdl_yaml.md rename to docs/pages_ru/documentation/reference/trdl_yaml.md index 7add3258..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 %} ## Организация артефактов релиза @@ -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` после сборки: ``` @@ -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 --- 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/documentation/security.html b/docs/pages_ru/documentation/security.html new file mode 100644 index 00000000..8cc8e28b --- /dev/null +++ b/docs/pages_ru/documentation/security.html @@ -0,0 +1,16 @@ +--- +title: Безопасность +permalink: documentation/security.html +layout: sidebar +--- + + +{% 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/index.html b/docs/pages_ru/index.html index 32788bd1..d63a33f5 100644 --- a/docs/pages_ru/index.html +++ b/docs/pages_ru/index.html @@ -4,21 +4,10 @@ layout: main-page --- - {% 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/whats-problems.html %} {% 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 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/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 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 %}