From b1d3439bd4165dac25d9513a41658f828b0b732e Mon Sep 17 00:00:00 2001 From: Lucas Fontes Date: Tue, 5 Nov 2024 13:56:04 -0500 Subject: [PATCH 1/4] go-imports: vanity url top directory Signed-off-by: Lucas Fontes --- go-imports/index.html | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 go-imports/index.html diff --git a/go-imports/index.html b/go-imports/index.html new file mode 100644 index 00000000..a7a904bd --- /dev/null +++ b/go-imports/index.html @@ -0,0 +1,5 @@ + + + + + From bb9107dff7e06eed15ca5f84a1568674858af42c Mon Sep 17 00:00:00 2001 From: Lucas Fontes Date: Tue, 5 Nov 2024 15:52:32 -0500 Subject: [PATCH 2/4] go-imports: Adding README Signed-off-by: Lucas Fontes --- go-imports/README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 go-imports/README.md diff --git a/go-imports/README.md b/go-imports/README.md new file mode 100644 index 00000000..d8f5c55c --- /dev/null +++ b/go-imports/README.md @@ -0,0 +1,22 @@ +# go.bytecodealliance.org Vanity URLs + +This directory hosts the configuration for Go vanity URLs under `go.bytecodealliance.org` domain. + +More information about vanity URLs can be found in the [Go documentation](https://golang.org/cmd/go/#hdr-Remote_import_paths). + +## Adding a new vanity URL + +If you want to create a vanity URL `go.bytecodealliance.org/foo` pointing to `github.com/bytecodealliance/go-foo`: + +- Create directory `foo` +- Create file `foo/index.html` with the following content: + + ```html + + + + + + ``` + +NOTE: Vanity URLs must be unique and not shadow existing package names in this repository. For ex: Creating a vanity URL `go.bytecodealliance.org/cm` would shadow the `cm` package in this repository. From 4a78cb2b62d7a74dd045f17b21278bdea17a3bb5 Mon Sep 17 00:00:00 2001 From: Lucas Fontes Date: Tue, 5 Nov 2024 15:52:58 -0500 Subject: [PATCH 3/4] docs: Moving `go-imports` -> `docs` Signed-off-by: Lucas Fontes --- {go-imports => docs}/README.md | 0 {go-imports => docs}/index.html | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename {go-imports => docs}/README.md (100%) rename {go-imports => docs}/index.html (100%) diff --git a/go-imports/README.md b/docs/README.md similarity index 100% rename from go-imports/README.md rename to docs/README.md diff --git a/go-imports/index.html b/docs/index.html similarity index 100% rename from go-imports/index.html rename to docs/index.html From a6b1d2e9fcb24864a94007821acc02076f153028 Mon Sep 17 00:00:00 2001 From: Lucas Fontes Date: Tue, 5 Nov 2024 16:07:25 -0500 Subject: [PATCH 4/4] docs: Addressing PR comments Signed-off-by: Lucas Fontes --- docs/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index d8f5c55c..55b180aa 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# go.bytecodealliance.org Vanity URLs +# go.bytecodealliance.org Go import paths This directory hosts the configuration for Go vanity URLs under `go.bytecodealliance.org` domain. @@ -8,8 +8,8 @@ More information about vanity URLs can be found in the [Go documentation](https: If you want to create a vanity URL `go.bytecodealliance.org/foo` pointing to `github.com/bytecodealliance/go-foo`: -- Create directory `foo` -- Create file `foo/index.html` with the following content: +- Create directory `docs/foo` +- Create file `docs/foo/index.html` with the following content: ```html @@ -19,4 +19,4 @@ If you want to create a vanity URL `go.bytecodealliance.org/foo` pointing to `gi ``` -NOTE: Vanity URLs must be unique and not shadow existing package names in this repository. For ex: Creating a vanity URL `go.bytecodealliance.org/cm` would shadow the `cm` package in this repository. +NOTE: Vanity URLs must be unique and not shadow existing package names in this repository. For example: Creating a vanity URL `go.bytecodealliance.org/cm` would shadow the `cm` package in this repository.