From afc5eb78db6a039517babf4fa54aba59bc4f6fe6 Mon Sep 17 00:00:00 2001 From: iwilltry42 Date: Mon, 7 Aug 2023 06:57:18 +0200 Subject: [PATCH] change: fix docs links --- CONTRIBUTING.md | 2 +- README.md | 2 +- cmd/image/imageImport.go | 2 +- docgen/README.md | 2 +- pkg/client/registry.go | 5 +++-- pkg/client/registry_test.go | 2 +- pkg/client/test.json | 2 +- 7 files changed, 9 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8dd096796..35bcd7a1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ We welcome everyone who likes to use and improve our software. Before starting to work with and on k3d, please read and understand our [**Code of Conduct**](./CODE_OF_CONDUCT.md). -Get an Overview of the k3d project in the documentation: [k3d.io/internals/project](https://k3d.io/internals/project) +Get an Overview of the k3d project in the documentation: [k3d.io/stable/design/project/](https://k3d.io/stable/design/project/) Before opening an issue or a Pull-Request, please use GitHub's search function to check whether something similar is already in process and hook in there instead. diff --git a/README.md b/README.md index b1a8d333c..e66d7e77f 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ k3d is a community-driven project and so we welcome contributions of any form, b Please read our [**Contributing Guidelines**](./CONTRIBUTING.md) and the related [**Code of Conduct**](./CODE_OF_CONDUCT.md). -You can find an overview of the k3d project (e.g. explanations and a repository guide) in the documentation: [k3d.io/internals/project](https://k3d.io/internals/project) +You can find an overview of the k3d project (e.g. explanations and a repository guide) in the documentation: [k3d.io/stable/design/project/](https://k3d.io/stable/design/project/) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md) diff --git a/cmd/image/imageImport.go b/cmd/image/imageImport.go index b2fab78a6..8c7f5305b 100644 --- a/cmd/image/imageImport.go +++ b/cmd/image/imageImport.go @@ -97,7 +97,7 @@ So if a file './k3d-io/k3d-tools' exists, k3d will try to import it instead of t cmd.Flags().BoolVarP(&loadImageOpts.KeepTar, "keep-tarball", "k", false, "Do not delete the tarball containing the saved images from the shared volume") cmd.Flags().BoolVarP(&loadImageOpts.KeepToolsNode, "keep-tools", "t", false, "Do not delete the tools node after import") - cmd.Flags().StringP("mode", "m", string(k3d.ImportModeToolsNode), "Which method to use to import images into the cluster [auto, direct, tools]. See https://k3d.io/usage/guides/importing_images/") + cmd.Flags().StringP("mode", "m", string(k3d.ImportModeToolsNode), "Which method to use to import images into the cluster [auto, direct, tools]. See https://k3d.io/stable/usage/importing_images/") /* Subcommands */ // done diff --git a/docgen/README.md b/docgen/README.md index ccc7b9cab..eed8f2010 100644 --- a/docgen/README.md +++ b/docgen/README.md @@ -1,6 +1,6 @@ # docgen -Only used to generate the command tree for . +Only used to generate the command tree for . The code will output files in [`../docs/usage/commands/`](../docs/usage/commands/) diff --git a/pkg/client/registry.go b/pkg/client/registry.go index ad84393ac..a950dd6b8 100644 --- a/pkg/client/registry.go +++ b/pkg/client/registry.go @@ -24,9 +24,10 @@ package client import ( "context" "fmt" - wharfie "github.com/rancher/wharfie/pkg/registries" gort "runtime" + wharfie "github.com/rancher/wharfie/pkg/registries" + "github.com/docker/go-connections/nat" "github.com/imdario/mergo" "sigs.k8s.io/yaml" @@ -329,7 +330,7 @@ func RegistryGenerateLocalRegistryHostingConfigMapYAML(ctx context.Context, runt Host: fmt.Sprintf("%s:%s", host, registries[0].ExposureOpts.Binding.HostPort), HostFromContainerRuntime: fmt.Sprintf("%s:%s", registries[0].Host, registries[0].ExposureOpts.Port.Port()), HostFromClusterNetwork: fmt.Sprintf("%s:%s", registries[0].Host, registries[0].ExposureOpts.Port.Port()), - Help: "https://k3d.io/usage/guides/registries/#using-a-local-registry", + Help: "https://k3d.io/stable/usage/registries/#using-a-local-registry", }, ) if err != nil { diff --git a/pkg/client/registry_test.go b/pkg/client/registry_test.go index 60ce98078..e1305e08a 100644 --- a/pkg/client/registry_test.go +++ b/pkg/client/registry_test.go @@ -37,7 +37,7 @@ func TestRegistryGenerateLocalRegistryHostingConfigMapYAML(t *testing.T) { expectedYAMLString := `apiVersion: v1 data: localRegistryHosting.v1: | - help: https://k3d.io/usage/guides/registries/#using-a-local-registry + help: https://k3d.io/stable/usage/registries/#using-a-local-registry host: test-host:5432 hostFromClusterNetwork: test-host:1234 hostFromContainerRuntime: test-host:1234 diff --git a/pkg/client/test.json b/pkg/client/test.json index e7a0ced3f..1ba3a7610 100644 --- a/pkg/client/test.json +++ b/pkg/client/test.json @@ -1 +1 @@ -{"host":"test-host:5432","hostFromContainerRuntime":"test-host:1234","help":"https://k3d.io/usage/guides/registries/#using-a-local-registry"} \ No newline at end of file +{"host":"test-host:5432","hostFromContainerRuntime":"test-host:1234","help":"https://k3d.io/stable/usage/registries/#using-a-local-registry"}