diff --git a/docs.json b/docs.json index 5750bec..c3c8f09 100644 --- a/docs.json +++ b/docs.json @@ -42,341 +42,179 @@ } ], "navigation": { - "products": [ + "tabs": [ { - "product": "Platform", - "icon": "cloud", - "tabs": [ + "tab": "Documentation", + "groups": [ { - "tab": "Documentation", - "groups": [ + "group": "Understand Kosli", + "icon": "book-open", + "pages": [ + "understand_kosli/what_is_kosli", + "understand_kosli/concepts" + ] + }, + { + "group": "Getting started", + "icon": "rocket", + "pages": [ + "getting_started/install", + "getting_started/service-accounts", + "getting_started/flows", + "getting_started/trails", + "getting_started/artifacts", + "getting_started/attestations", + "getting_started/environments", + "getting_started/policies", + "getting_started/approvals" + ] + }, + { + "group": "Administration", + "icon": "cog", + "pages": [ { - "group": "Understand Kosli", - "icon": "book-open", + "group": "Managing Users", "pages": [ - "understand_kosli/what_is_kosli", - "understand_kosli/concepts" + "administration/managing_users/roles_in_kosli" ] }, + { + "group": "Managing Environments", + "pages": [ + "administration/managing_environments/overview" + ] + } + ] + }, + { + "group": "Tutorials", + "icon": "graduation-cap", + "pages": [ { "group": "Getting started", - "icon": "rocket", "pages": [ - "getting_started/install", - "getting_started/service-accounts", - "getting_started/flows", - "getting_started/trails", - "getting_started/artifacts", - "getting_started/attestations", - "getting_started/environments", - "getting_started/policies", - "getting_started/approvals" + "tutorials/get_familiar_with_Kosli", + "tutorials/cli_and_http_proxy" ] }, { - "group": "Administration", - "icon": "cog", + "group": "Attesting", "pages": [ - { - "group": "Managing Users", - "pages": [ - "administration/managing_users/roles_in_kosli" - ] - }, - { - "group": "Managing Environments", - "pages": [ - "administration/managing_environments/overview" - ] - } + "tutorials/attest_snyk", + "tutorials/custom-attestation-ctrf" ] }, { - "group": "Tutorials", - "icon": "graduation-cap", + "group": "Reporting environments", "pages": [ - { - "group": "Getting started", - "pages": [ - "tutorials/get_familiar_with_Kosli", - "tutorials/cli_and_http_proxy" - ] - }, - { - "group": "Attesting", - "pages": [ - "tutorials/attest_snyk", - "tutorials/custom-attestation-ctrf" - ] - }, - { - "group": "Reporting environments", - "pages": [ - "tutorials/report_aws_envs", - "tutorials/report_k8s_envs" - ] - }, - { - "group": "Querying & tracing", - "pages": [ - "tutorials/querying_kosli", - "tutorials/following_a_git_commit_to_runtime_environments", - "tutorials/tracing_a_production_incident_back_to_git_commits" - ] - }, - { - "group": "Security", - "pages": [ - "tutorials/unauthorized_iac_changes" - ] - } + "tutorials/report_aws_envs", + "tutorials/report_k8s_envs" ] }, { - "group": "Troubleshooting", - "icon": "wrench", + "group": "Querying & tracing", "pages": [ - "troubleshooting/what_do_i_do_if_kosli_is_down" + "tutorials/querying_kosli", + "tutorials/following_a_git_commit_to_runtime_environments", + "tutorials/tracing_a_production_incident_back_to_git_commits" ] }, { - "group": "Integrations", - "icon": "puzzle-piece", + "group": "Security", "pages": [ - "integrations/actions", - "integrations/ci_cd", - "integrations/slack", - "integrations/launchdarkly", - "integrations/sonar" + "tutorials/unauthorized_iac_changes" ] } ] }, { - "tab": "Implementation Guide", - "groups": [ + "group": "Troubleshooting", + "icon": "wrench", + "pages": [ + "troubleshooting/what_do_i_do_if_kosli_is_down" + ] + }, + { + "group": "Integrations", + "icon": "puzzle-piece", + "pages": [ + "integrations/actions", + "integrations/ci_cd", + "integrations/slack", + "integrations/launchdarkly", + "integrations/sonar" + ] + } + ] + }, + { + "tab": "Implementation Guide", + "groups": [ + { + "group": "Phase 1: Initial Discovery", + "icon": "lightbulb", + "pages": [ { - "group": "Phase 1: Initial Discovery", - "icon": "lightbulb", + "group": "Roles & Responsibilities", "pages": [ - { - "group": "Roles & Responsibilities", - "pages": [ - "implementation_guide/phase_1/roles_and_responsibilities/overview", - "implementation_guide/phase_1/roles_and_responsibilities/platform_engineers", - "implementation_guide/phase_1/roles_and_responsibilities/app_developers", - "implementation_guide/phase_1/roles_and_responsibilities/security_compliance", - "implementation_guide/phase_1/roles_and_responsibilities/sponsors" - ] - } + "implementation_guide/phase_1/roles_and_responsibilities/overview", + "implementation_guide/phase_1/roles_and_responsibilities/platform_engineers", + "implementation_guide/phase_1/roles_and_responsibilities/app_developers", + "implementation_guide/phase_1/roles_and_responsibilities/security_compliance", + "implementation_guide/phase_1/roles_and_responsibilities/sponsors" ] - }, + } + ] + }, + { + "group": "Phase 2: Configure Kosli", + "icon": "gear", + "pages": [ { - "group": "Phase 2: Configure Kosli", - "icon": "gear", + "group": "Plan Organizational Structure", "pages": [ { - "group": "Plan Organizational Structure", + "group": "Naming Conventions", "pages": [ - { - "group": "Naming Conventions", - "pages": [ - "implementation_guide/phase_2/plan_organizational_structure/naming_conventions/overview", - "implementation_guide/phase_2/plan_organizational_structure/naming_conventions/attestation_types", - "implementation_guide/phase_2/plan_organizational_structure/naming_conventions/flows_and_trails" - ] - } + "implementation_guide/phase_2/plan_organizational_structure/naming_conventions/overview", + "implementation_guide/phase_2/plan_organizational_structure/naming_conventions/attestation_types", + "implementation_guide/phase_2/plan_organizational_structure/naming_conventions/flows_and_trails" ] } ] } ] - }, + } + ] + }, + { + "tab": "Reference", + "menu": [ { - "tab": "Reference", - "menu": [ + "item": "CLI Reference", + "icon": "terminal", + "groups": [ { - "item": "CLI Reference", - "icon": "terminal", - "groups": [ - { - "group": "General", - "pages": [ - "client_reference/overview", - "client_reference/kosli", - "client_reference/kosli_attach-policy", - "client_reference/kosli_completion", - "client_reference/kosli_config", - "client_reference/kosli_detach-policy", - "client_reference/kosli_fingerprint", - "client_reference/kosli_search", - "client_reference/kosli_status", - "client_reference/kosli_tag", - "client_reference/kosli_version" - ] - }, - { - "group": "kosli allow", - "pages": [ - "client_reference/kosli_allow_artifact" - ] - }, - { - "group": "kosli archive", - "pages": [ - "client_reference/kosli_archive_attestation-type", - "client_reference/kosli_archive_environment", - "client_reference/kosli_archive_flow" - ] - }, - { - "group": "kosli assert", - "pages": [ - "client_reference/kosli_assert_approval", - "client_reference/kosli_assert_artifact", - "client_reference/kosli_assert_pullrequest_azure", - "client_reference/kosli_assert_pullrequest_bitbucket", - "client_reference/kosli_assert_pullrequest_github", - "client_reference/kosli_assert_pullrequest_gitlab", - "client_reference/kosli_assert_snapshot", - "client_reference/kosli_assert_status" - ] - }, - { - "group": "kosli attest", - "pages": [ - "client_reference/kosli_attest_artifact", - "client_reference/kosli_attest_custom", - "client_reference/kosli_attest_generic", - "client_reference/kosli_attest_jira", - "client_reference/kosli_attest_junit", - "client_reference/kosli_attest_pullrequest_azure", - "client_reference/kosli_attest_pullrequest_bitbucket", - "client_reference/kosli_attest_pullrequest_github", - "client_reference/kosli_attest_pullrequest_gitlab", - "client_reference/kosli_attest_snyk", - "client_reference/kosli_attest_sonar" - ] - }, - { - "group": "kosli begin", - "pages": [ - "client_reference/kosli_begin_trail" - ] - }, - { - "group": "kosli create", - "pages": [ - "client_reference/kosli_create_attestation-type", - "client_reference/kosli_create_environment", - "client_reference/kosli_create_flow", - "client_reference/kosli_create_policy" - ] - }, - { - "group": "kosli diff", - "pages": [ - "client_reference/kosli_diff_snapshots" - ] - }, - { - "group": "kosli disable / enable", - "pages": [ - "client_reference/kosli_disable_beta", - "client_reference/kosli_enable_beta" - ] - }, - { - "group": "kosli evaluate", - "pages": [ - "client_reference/kosli_evaluate_trail", - "client_reference/kosli_evaluate_trails" - ] - }, - { - "group": "kosli get", - "pages": [ - "client_reference/kosli_get_approval", - "client_reference/kosli_get_artifact", - "client_reference/kosli_get_attestation-type", - "client_reference/kosli_get_attestation", - "client_reference/kosli_get_deployment", - "client_reference/kosli_get_environment", - "client_reference/kosli_get_flow", - "client_reference/kosli_get_policy", - "client_reference/kosli_get_snapshot", - "client_reference/kosli_get_trail" - ] - }, - { - "group": "kosli join", - "pages": [ - "client_reference/kosli_join_environment" - ] - }, - { - "group": "kosli list", - "pages": [ - "client_reference/kosli_list_approvals", - "client_reference/kosli_list_artifacts", - "client_reference/kosli_list_attestation-types", - "client_reference/kosli_list_deployments", - "client_reference/kosli_list_environments", - "client_reference/kosli_list_flows", - "client_reference/kosli_list_policies", - "client_reference/kosli_list_snapshots", - "client_reference/kosli_list_trails" - ] - }, - { - "group": "kosli log", - "pages": [ - "client_reference/kosli_log_environment" - ] - }, - { - "group": "kosli rename", - "pages": [ - "client_reference/kosli_rename_environment", - "client_reference/kosli_rename_flow" - ] - }, - { - "group": "kosli report", - "pages": [ - "client_reference/kosli_report_approval" - ] - }, - { - "group": "kosli request", - "pages": [ - "client_reference/kosli_request_approval" - ] - }, - { - "group": "kosli snapshot", - "pages": [ - "client_reference/kosli_snapshot_azure", - "client_reference/kosli_snapshot_docker", - "client_reference/kosli_snapshot_ecs", - "client_reference/kosli_snapshot_k8s", - "client_reference/kosli_snapshot_lambda", - "client_reference/kosli_snapshot_path", - "client_reference/kosli_snapshot_paths", - "client_reference/kosli_snapshot_s3" - ] - }, - { - "group": "Deprecated", - "pages": [ - "client_reference/kosli_expect_deployment", - "client_reference/kosli_report_artifact", - "client_reference/kosli_snapshot_server" - ] - } + "group": "General", + "pages": [ + "client_reference/overview", + "client_reference/kosli", + "client_reference/kosli_attach-policy", + "client_reference/kosli_completion", + "client_reference/kosli_config", + "client_reference/kosli_detach-policy", + "client_reference/kosli_fingerprint", + "client_reference/kosli_search", + "client_reference/kosli_status", + "client_reference/kosli_tag", + "client_reference/kosli_version" ] }, { + "group": "kosli allow", + "pages": [ + "client_reference/kosli_allow_artifact" "item": "Helm Reference", "icon": "helm", "groups": [ @@ -389,31 +227,196 @@ ] }, { - "item": "API Reference", - "icon": "code", - "groups": [ - { - "group": "Environments", - "pages": [ - "api-reference/endpoint/list_environments", - "api-reference/endpoint/put_environment" - ] - } + "group": "kosli archive", + "pages": [ + "client_reference/kosli_archive_attestation-type", + "client_reference/kosli_archive_environment", + "client_reference/kosli_archive_flow" + ] + }, + { + "group": "kosli assert", + "pages": [ + "client_reference/kosli_assert_approval", + "client_reference/kosli_assert_artifact", + "client_reference/kosli_assert_pullrequest_azure", + "client_reference/kosli_assert_pullrequest_bitbucket", + "client_reference/kosli_assert_pullrequest_github", + "client_reference/kosli_assert_pullrequest_gitlab", + "client_reference/kosli_assert_snapshot", + "client_reference/kosli_assert_status" + ] + }, + { + "group": "kosli attest", + "pages": [ + "client_reference/kosli_attest_artifact", + "client_reference/kosli_attest_custom", + "client_reference/kosli_attest_generic", + "client_reference/kosli_attest_jira", + "client_reference/kosli_attest_junit", + "client_reference/kosli_attest_pullrequest_azure", + "client_reference/kosli_attest_pullrequest_bitbucket", + "client_reference/kosli_attest_pullrequest_github", + "client_reference/kosli_attest_pullrequest_gitlab", + "client_reference/kosli_attest_snyk", + "client_reference/kosli_attest_sonar" + ] + }, + { + "group": "kosli begin", + "pages": [ + "client_reference/kosli_begin_trail" + ] + }, + { + "group": "kosli create", + "pages": [ + "client_reference/kosli_create_attestation-type", + "client_reference/kosli_create_environment", + "client_reference/kosli_create_flow", + "client_reference/kosli_create_policy" + ] + }, + { + "group": "kosli diff", + "pages": [ + "client_reference/kosli_diff_snapshots" + ] + }, + { + "group": "kosli disable / enable", + "pages": [ + "client_reference/kosli_disable_beta", + "client_reference/kosli_enable_beta" + ] + }, + { + "group": "kosli evaluate", + "pages": [ + "client_reference/kosli_evaluate_trail", + "client_reference/kosli_evaluate_trails" + ] + }, + { + "group": "kosli get", + "pages": [ + "client_reference/kosli_get_approval", + "client_reference/kosli_get_artifact", + "client_reference/kosli_get_attestation-type", + "client_reference/kosli_get_attestation", + "client_reference/kosli_get_deployment", + "client_reference/kosli_get_environment", + "client_reference/kosli_get_flow", + "client_reference/kosli_get_policy", + "client_reference/kosli_get_snapshot", + "client_reference/kosli_get_trail" + ] + }, + { + "group": "kosli join", + "pages": [ + "client_reference/kosli_join_environment" + ] + }, + { + "group": "kosli list", + "pages": [ + "client_reference/kosli_list_approvals", + "client_reference/kosli_list_artifacts", + "client_reference/kosli_list_attestation-types", + "client_reference/kosli_list_deployments", + "client_reference/kosli_list_environments", + "client_reference/kosli_list_flows", + "client_reference/kosli_list_policies", + "client_reference/kosli_list_snapshots", + "client_reference/kosli_list_trails" + ] + }, + { + "group": "kosli log", + "pages": [ + "client_reference/kosli_log_environment" + ] + }, + { + "group": "kosli rename", + "pages": [ + "client_reference/kosli_rename_environment", + "client_reference/kosli_rename_flow" + ] + }, + { + "group": "kosli report", + "pages": [ + "client_reference/kosli_report_approval" + ] + }, + { + "group": "kosli request", + "pages": [ + "client_reference/kosli_request_approval" + ] + }, + { + "group": "kosli snapshot", + "pages": [ + "client_reference/kosli_snapshot_azure", + "client_reference/kosli_snapshot_docker", + "client_reference/kosli_snapshot_ecs", + "client_reference/kosli_snapshot_k8s", + "client_reference/kosli_snapshot_lambda", + "client_reference/kosli_snapshot_path", + "client_reference/kosli_snapshot_paths", + "client_reference/kosli_snapshot_s3" + ] + }, + { + "group": "Deprecated", + "pages": [ + "client_reference/kosli_expect_deployment", + "client_reference/kosli_report_artifact", + "client_reference/kosli_snapshot_server" ] } ] }, { - "tab": "Changelog", - "icon": "clock", + "item": "Helm Reference", + "icon": "helm", "groups": [ { - "group": "Changelog", + "group": "Helm Charts", "pages": [ - "changelog/index" + "helm/k8s_reporter" ] } ] + }, + { + "item": "API Reference", + "icon": "code", + "groups": [ + { + "group": "Environments", + "pages": [ + "api-reference/endpoint/list_environments", + "api-reference/endpoint/put_environment" + ] + } + ] + } + ] + }, + { + "tab": "Changelog", + "icon": "clock", + "groups": [ + { + "group": "Changelog", + "pages": [ + "changelog/index" + ] } ] }