From 28ab28138fd46c5771c1360a470c7221f7f1f99b Mon Sep 17 00:00:00 2001 From: AlinaGoaga <35202557+AlinaGoaga@users.noreply.github.com> Date: Wed, 6 Dec 2023 13:16:24 +0100 Subject: [PATCH] Add UI subpath info for EE (#4156) * Add ui subpath info for EE * Add ui subpath info for EE - 2 * Move ui path file to right location * Add ui subpath info for EE to versioned docs * Move run ui under a subpath instructions under guides * Remove open-source/getting-started/run-ui-subpath from sidebars def * Remove open-source/getting-started/run-ui-subpath from sidebars def - versioned docs * Fix formatting error * Update Running the UI on a Subpath page title --- .../run-ui-subpath.mdx | 6 +- website/sidebars.js | 312 +++++++++--------- .../run-ui-subpath.mdx | 6 +- .../version-0.37.0-sidebars.json | 6 +- 4 files changed, 159 insertions(+), 171 deletions(-) rename website/docs/{open-source/getting-started => guides}/run-ui-subpath.mdx (85%) rename website/versioned_docs/version-0.37.0/{open-source/getting-started => guides}/run-ui-subpath.mdx (85%) diff --git a/website/docs/open-source/getting-started/run-ui-subpath.mdx b/website/docs/guides/run-ui-subpath.mdx similarity index 85% rename from website/docs/open-source/getting-started/run-ui-subpath.mdx rename to website/docs/guides/run-ui-subpath.mdx index e0cf2d70e1..55439b5fce 100644 --- a/website/docs/open-source/getting-started/run-ui-subpath.mdx +++ b/website/docs/guides/run-ui-subpath.mdx @@ -1,11 +1,11 @@ --- -title: "Optional: Running the UI on a Subpath" +title: "Running the UI on a Subpath" --- ## Running the UI on a subpath By default, the UI is served on the root path `/`. It is possible to run the UI on a subpath, for example `/weave-gitops`. -This is useful if you want to run weave-gitops alongside other applications on the same domain. +This is useful if you want to run weave-gitops or weave-gitops-enterprise alongside other applications on the same domain. To run the UI on a subpath, you need to set the `--route-prefix` flag on the weave-gitops server. For example, if you want to run the UI on `/weave-gitops`, you can set the flag to `--route-prefix=/weave-gitops`. @@ -44,4 +44,4 @@ spec: pathType: Prefix ``` -See the [Helm chart reference](../../references/helm-reference.md) for a list of all supported ingress options. \ No newline at end of file +See the [Helm chart reference](../references/helm-reference.md) for a list of all supported ingress options. \ No newline at end of file diff --git a/website/sidebars.js b/website/sidebars.js index edbe651a29..93182288dd 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -9,279 +9,267 @@ Create as many sidebars as you want. */ - module.exports = { +module.exports = { docs: [ { - type: 'category', - label: 'Introducing Weave GitOps', + type: "category", + label: "Introducing Weave GitOps", collapsed: false, link: { - type: 'doc', - id: 'intro-weave-gitops', + type: "doc", + id: "intro-weave-gitops", }, items: [ { - type: 'category', - label: 'Weave GitOps Open Source', + type: "category", + label: "Weave GitOps Open Source", collapsed: false, items: [ - 'open-source/getting-started/install-OSS', - 'open-source/getting-started/ui-OSS', - 'open-source/getting-started/deploy-OSS', - 'open-source/getting-started/aws-marketplace', - 'open-source/getting-started/run-ui-subpath', + "open-source/getting-started/install-OSS", + "open-source/getting-started/ui-OSS", + "open-source/getting-started/deploy-OSS", + "open-source/getting-started/aws-marketplace", ], }, { - type: 'category', - label: 'Weave GitOps Enterprise', + type: "category", + label: "Weave GitOps Enterprise", link: { - type: 'doc', - id: 'enterprise/getting-started/intro-enterprise', + type: "doc", + id: "enterprise/getting-started/intro-enterprise", }, items: [ - 'enterprise/getting-started/install-enterprise', - 'enterprise/getting-started/install-enterprise-cli', - 'enterprise/getting-started/install-enterprise-airgap', - 'enterprise/getting-started/releases-enterprise', - 'enterprise/getting-started/install-enterprise-azure', - 'enterprise/getting-started/join-cluster-azure-flux', - ], - }, + "enterprise/getting-started/install-enterprise", + "enterprise/getting-started/install-enterprise-cli", + "enterprise/getting-started/install-enterprise-airgap", + "enterprise/getting-started/releases-enterprise", + "enterprise/getting-started/install-enterprise-azure", + "enterprise/getting-started/join-cluster-azure-flux", + ], + }, { - type: 'link', - label: 'Version Archives', - href: '/archives', + type: "link", + label: "Version Archives", + href: "/archives", }, ], }, { - type: 'category', - label: 'Backstage', + type: "category", + label: "Backstage", link: { - type: 'doc', - id: 'backstage/intro' + type: "doc", + id: "backstage/intro", }, items: [], }, - { - type: 'category', - label: 'Cluster Management', + { + type: "category", + label: "Cluster Management", link: { - type: 'doc', - id: 'cluster-management/cluster-management-intro', + type: "doc", + id: "cluster-management/cluster-management-intro", }, items: [ - 'cluster-management/managing-clusters-without-capi', - 'cluster-management/deploying-capa-eks', - 'cluster-management/profiles', - 'cluster-management/cluster-management-troubleshooting', + "cluster-management/managing-clusters-without-capi", + "cluster-management/deploying-capa-eks", + "cluster-management/profiles", + "cluster-management/cluster-management-troubleshooting", { - type: 'category', - label: 'Advanced Cluster Management', + type: "category", + label: "Advanced Cluster Management", items: [ - 'cluster-management/advanced-cluster-management-topics/howto-inject-credentials-into-template' + "cluster-management/advanced-cluster-management-topics/howto-inject-credentials-into-template", ], }, ], }, { - type: 'category', - label: 'Explorer', + type: "category", + label: "Explorer", link: { - type: 'doc', - id: 'explorer/intro', + type: "doc", + id: "explorer/intro", }, items: [ - 'explorer/getting-started', - 'explorer/configuration', - 'explorer/querying', - 'explorer/operations', + "explorer/getting-started", + "explorer/configuration", + "explorer/querying", + "explorer/operations", ], }, { - type: 'category', - label: 'GitOpsSets', + type: "category", + label: "GitOpsSets", items: [ - 'gitopssets/gitopssets-intro', - 'gitopssets/gitopssets-installation', - 'gitopssets/templating-from-generators', - 'gitopssets/gitopssets-api-reference', - 'gitopssets/gitopssets-releases' + "gitopssets/gitopssets-intro", + "gitopssets/gitopssets-installation", + "gitopssets/templating-from-generators", + "gitopssets/gitopssets-api-reference", + "gitopssets/gitopssets-releases", ], }, { - type: 'category', - label: 'Guides', + type: "category", + label: "Guides", items: [ - 'guides/oidc', - 'guides/configuring-oidc-with-keycloak', - 'guides/displaying-custom-metadata', - 'guides/fluxga-upgrade', - 'guides/anonymous-access', + "guides/oidc", + "guides/configuring-oidc-with-keycloak", + "guides/displaying-custom-metadata", + "guides/fluxga-upgrade", + "guides/anonymous-access", + "guides/run-ui-subpath", ], }, { - type: 'category', - label: 'Operations', - items: [ - 'operations/monitoring', - ], + type: "category", + label: "Operations", + items: ["operations/monitoring"], }, { - type: 'category', - label: 'Pipelines', + type: "category", + label: "Pipelines", link: { - type: 'doc', - id: 'pipelines/pipelines-intro', + type: "doc", + id: "pipelines/pipelines-intro", }, items: [ - 'pipelines/pipelines-getting-started', - 'pipelines/authorization', - 'pipelines/promoting-applications', - 'pipelines/pipelines-templates', - 'pipelines/pipelines-with-jenkins', - 'pipelines/pipelines-with-tekton', + "pipelines/pipelines-getting-started", + "pipelines/authorization", + "pipelines/promoting-applications", + "pipelines/pipelines-templates", + "pipelines/pipelines-with-jenkins", + "pipelines/pipelines-with-tekton", { - type: 'category', - label: 'Reference', + type: "category", + label: "Reference", items: [ { - type: 'category', - label: 'v1alpha1', - items: [ - 'pipelines/spec/v1alpha1/pipeline', - ], + type: "category", + label: "v1alpha1", + items: ["pipelines/spec/v1alpha1/pipeline"], }, ], }, ], }, { - type: 'category', - label: 'Policy', + type: "category", + label: "Policy", link: { - type: 'doc', - id: 'policy/intro', + type: "doc", + id: "policy/intro", }, items: [ - 'policy/getting-started', - 'policy/authorization', - 'policy/policy', - 'policy/weave-policy-profile', - 'policy/policy-set', - 'policy/policy-configuration', - 'policy/releases', - 'policy/commit-time-checks', + "policy/getting-started", + "policy/authorization", + "policy/policy", + "policy/weave-policy-profile", + "policy/policy-set", + "policy/policy-configuration", + "policy/releases", + "policy/commit-time-checks", ], }, { - type: 'category', - label: 'Progressive Delivery', + type: "category", + label: "Progressive Delivery", link: { - type: 'doc', - id: 'progressive-delivery/progressive-delivery-flagger-install', + type: "doc", + id: "progressive-delivery/progressive-delivery-flagger-install", }, - items: [ - 'progressive-delivery/flagger-manual-gating', - ], + items: ["progressive-delivery/flagger-manual-gating"], }, { - type: 'category', - label: 'Secrets', + type: "category", + label: "Secrets", link: { - type: 'doc', - id: 'secrets/intro', + type: "doc", + id: "secrets/intro", }, items: [ - 'secrets/intro', - 'secrets/getting-started', - 'secrets/bootstrapping-secrets', - 'secrets/setup-eso', - 'secrets/setup-sops', - 'secrets/manage-secrets-ui', + "secrets/intro", + "secrets/getting-started", + "secrets/bootstrapping-secrets", + "secrets/setup-eso", + "secrets/setup-sops", + "secrets/manage-secrets-ui", // 'secrets/self-service', { - type: 'category', - label: 'Reference', + type: "category", + label: "Reference", items: [ { - type: 'category', - label: 'v1alpha1', - items: [ - 'secrets/spec/v1alpha1/secretSync', - ], + type: "category", + label: "v1alpha1", + items: ["secrets/spec/v1alpha1/secretSync"], }, ], }, ], }, { - type: 'category', - label: 'Templates', + type: "category", + label: "Templates", link: { - type: 'doc', - id: 'gitops-templates/intro', + type: "doc", + id: "gitops-templates/intro", }, items: [ - 'gitops-templates/quickstart-templates', + "gitops-templates/quickstart-templates", { - type: 'category', - label: 'Creating Templates', + type: "category", + label: "Creating Templates", link: { - type: 'doc', - id: 'gitops-templates/creating-templates', + type: "doc", + id: "gitops-templates/creating-templates", }, items: [ - 'gitops-templates/resource-templates', - 'gitops-templates/repo-rendered-paths', - 'gitops-templates/profiles', - 'gitops-templates/annotations', - 'gitops-templates/params', - 'gitops-templates/supported-langs', - 'gitops-templates/create-cluster-example', + "gitops-templates/resource-templates", + "gitops-templates/repo-rendered-paths", + "gitops-templates/profiles", + "gitops-templates/annotations", + "gitops-templates/params", + "gitops-templates/supported-langs", + "gitops-templates/create-cluster-example", ], }, - 'gitops-templates/cli', - 'gitops-templates/versions', + "gitops-templates/cli", + "gitops-templates/versions", ], }, { - type: 'category', - label: 'Terraform', + type: "category", + label: "Terraform", items: [ - 'terraform/terraform-intro', - 'terraform/get-started-terraform', - 'terraform/using-terraform-templates', + "terraform/terraform-intro", + "terraform/get-started-terraform", + "terraform/using-terraform-templates", ], }, { - type: 'category', - label: 'Workspaces', + type: "category", + label: "Workspaces", link: { - type: 'doc', - id: 'workspaces/intro', + type: "doc", + id: "workspaces/intro", }, - items: [ - 'workspaces/multi-tenancy', - 'workspaces/view-workspaces', - ], + items: ["workspaces/multi-tenancy", "workspaces/view-workspaces"], }, - ], ref: [ { - type: 'doc', - label: 'OSS Helm Reference', - id: 'references/helm-reference', + type: "doc", + label: "OSS Helm Reference", + id: "references/helm-reference", }, { - type: 'category', - label: 'CLI Reference', + type: "category", + label: "CLI Reference", items: [ { - type: 'autogenerated', - dirName: 'references/cli-reference', + type: "autogenerated", + dirName: "references/cli-reference", }, ], }, diff --git a/website/versioned_docs/version-0.37.0/open-source/getting-started/run-ui-subpath.mdx b/website/versioned_docs/version-0.37.0/guides/run-ui-subpath.mdx similarity index 85% rename from website/versioned_docs/version-0.37.0/open-source/getting-started/run-ui-subpath.mdx rename to website/versioned_docs/version-0.37.0/guides/run-ui-subpath.mdx index e0cf2d70e1..cff7902efe 100644 --- a/website/versioned_docs/version-0.37.0/open-source/getting-started/run-ui-subpath.mdx +++ b/website/versioned_docs/version-0.37.0/guides/run-ui-subpath.mdx @@ -1,11 +1,11 @@ --- -title: "Optional: Running the UI on a Subpath" +title: "Running the UI on a Subpath" --- ## Running the UI on a subpath By default, the UI is served on the root path `/`. It is possible to run the UI on a subpath, for example `/weave-gitops`. -This is useful if you want to run weave-gitops alongside other applications on the same domain. +This is useful if you want to run weave-gitops or weave-gitops-enterprise alongside alongside other applications on the same domain. To run the UI on a subpath, you need to set the `--route-prefix` flag on the weave-gitops server. For example, if you want to run the UI on `/weave-gitops`, you can set the flag to `--route-prefix=/weave-gitops`. @@ -44,4 +44,4 @@ spec: pathType: Prefix ``` -See the [Helm chart reference](../../references/helm-reference.md) for a list of all supported ingress options. \ No newline at end of file +See the [Helm chart reference](../references/helm-reference.md) for a list of all supported ingress options. \ No newline at end of file diff --git a/website/versioned_sidebars/version-0.37.0-sidebars.json b/website/versioned_sidebars/version-0.37.0-sidebars.json index a4cfbd1833..08c1596140 100644 --- a/website/versioned_sidebars/version-0.37.0-sidebars.json +++ b/website/versioned_sidebars/version-0.37.0-sidebars.json @@ -17,8 +17,7 @@ "open-source/getting-started/install-OSS", "open-source/getting-started/ui-OSS", "open-source/getting-started/deploy-OSS", - "open-source/getting-started/aws-marketplace", - "open-source/getting-started/run-ui-subpath" + "open-source/getting-started/aws-marketplace" ] }, { @@ -107,7 +106,8 @@ "guides/configuring-oidc-with-keycloak", "guides/displaying-custom-metadata", "guides/fluxga-upgrade", - "guides/anonymous-access" + "guides/anonymous-access", + "guides/run-ui-subpath" ] }, {