Skip to content

Commit

Permalink
change: fix docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
iwilltry42 committed Aug 7, 2023
1 parent 14c5358 commit afc5eb7
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion cmd/image/imageImport.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docgen/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# docgen

Only used to generate the command tree for <https://k3d.io/usage/commands>.
Only used to generate the command tree for <https://k3d.io/stable/usage/commands>.

The code will output files in [`../docs/usage/commands/`](../docs/usage/commands/)

Expand Down
5 changes: 3 additions & 2 deletions pkg/client/registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion pkg/client/registry_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pkg/client/test.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"host":"test-host:5432","hostFromContainerRuntime":"test-host:1234","help":"https://k3d.io/usage/guides/registries/#using-a-local-registry"}
{"host":"test-host:5432","hostFromContainerRuntime":"test-host:1234","help":"https://k3d.io/stable/usage/registries/#using-a-local-registry"}

0 comments on commit afc5eb7

Please sign in to comment.