Skip to content

Commit 5aeb9fb

Browse files
authored
Update docs links to reflect restructured repo (#214)
* Update docs links to reflect restructured repo
1 parent 8637c40 commit 5aeb9fb

21 files changed

+66
-67
lines changed

tools/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The WebAssembly Hub acts as an image registry for WebAssembly Filters hosted at
2424
- compile [Envoy WebAssembly](https://github.com/envoyproxy/envoy-wasm) filters on a local machine (the only dependency is `docker`)
2525
- push filters to https://webassemblyhub.io
2626
- pull filters from https://webassemblyhub.io
27-
- publish filters to the catalog at https://webassemblyhub.io/extensions/
27+
- publish filters to the catalog at https://webassemblyhub.io/extensions/
2828

2929
### Getting Started
3030

@@ -34,4 +34,4 @@ See the [Getting Started tutorial](https://docs.solo.io/web-assembly-hub/latest/
3434
- Join us on our Slack channel: [https://slack.solo.io/](https://slack.solo.io/)
3535
- Follow us on Twitter: [https://twitter.com/soloio_inc](https://twitter.com/soloio_inc)
3636
- Check out the docs: [https://docs.solo.io/web-assembly-hub/latest](https://docs.solo.io/web-assembly-hub/latest)
37-
- Contribute to the [Docs](https://github.com/solo-io/wasme)
37+
- Contribute to the [Docs](https://github.com/solo-io/wasm)
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: NEW_FEATURE
33
description: Adds the new Wasme Operator for deploying filters to production.
4-
issueLink: https://github.com/solo-io/wasme/issues/42
4+
issueLink: https://github.com/solo-io/wasm/issues/42
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: FIX
33
description: 'Fix `wasme deploy envoy` command and update it with a cleaner experience using the local cache.'
4-
issueLink: https://github.com/solo-io/wasme/issues/72
4+
issueLink: https://github.com/solo-io/wasm/issues/72

tools/wasme/changelog/v0.0.13/gloo-e2e.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ changelog:
55
description: 'Update & improve documentation'
66
- type: NEW_FEATURE
77
description: 'Support use of labelSelector to deploy filters to Istio'
8-
issueLink: https://github.com/solo-io/wasme/issues/43
8+
issueLink: https://github.com/solo-io/wasm/issues/43
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: NEW_FEATURE
33
description: 'Adds support for `init` and `build` for the AssemblyScript language: https://github.com/AssemblyScript/assemblyscript'
4-
issueLink: https://github.com/solo-io/wasme/issues/71
4+
issueLink: https://github.com/solo-io/wasm/issues/71
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
changelog:
22
- type: NEW_FEATURE
33
description: 'List all repos with `wasme list`'
4-
issueLink: https://github.com/solo-io/wasme/issues/80
5-
4+
issueLink: https://github.com/solo-io/wasm/issues/80
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: FIX
33
description: Fix cache race by firing events
4-
issueLink: https://github.com/solo-io/wasme/issues/64
4+
issueLink: https://github.com/solo-io/wasm/issues/64
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: FIX
33
description: Fix issue where `wasme list` would return an error if the cache had not been initialized with `wasme build` or `wasme pull`.
4-
issueLink: https://github.com/solo-io/wasme/issues/87
4+
issueLink: https://github.com/solo-io/wasm/issues/87
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: FIX
33
description: Fix incorrect base selection on wasme init command.
4-
issueLink: https://github.com/solo-io/wasme/issues/90
4+
issueLink: https://github.com/solo-io/wasm/issues/90
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: FIX
33
description: Fix issue where `wasme list` returns an empty list if --store is not set
4-
issueLink: https://github.com/solo-io/wasme/issues/87
4+
issueLink: https://github.com/solo-io/wasm/issues/87
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: FIX
33
description: Allow wasme cache to use credentials given to its command line.
4-
issueLink: https://github.com/solo-io/wasme/pull/102
4+
issueLink: https://github.com/solo-io/wasm/pull/102
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: NEW_FEATURE
33
description: 'Add support for Istio v1.6.x'
4-
issueLink: https://github.com/solo-io/wasme/issues/126
4+
issueLink: https://github.com/solo-io/wasm/issues/126
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: FIX
33
description: Fix Bookinfo URL.
4-
issueLink: https://github.com/solo-io/wasme/issues/122
4+
issueLink: https://github.com/solo-io/wasm/issues/122
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: FIX
33
description: Fix user-facing typo - cahced.
4-
issueLink: https://github.com/solo-io/wasme/issues/77
4+
issueLink: https://github.com/solo-io/wasm/issues/77
+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
changelog:
22
- type: NEW_FEATURE
33
description: 'Add support for gloo v1.5.x'
4-
issueLink: https://github.com/solo-io/wasme/issues/130
4+
issueLink: https://github.com/solo-io/wasm/issues/130
55
- type: NON_USER_FACING
66
description: Fix broken build by pinning skv2 version and formatting imports
7-
issueLink: https://github.com/solo-io/wasme/issues/124
7+
issueLink: https://github.com/solo-io/wasm/issues/124
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: FIX
33
description: Allows using --config param in CLI deploy command for both Istio and Gloo again
4-
issueLink: https://github.com/solo-io/wasme/issues/130
4+
issueLink: https://github.com/solo-io/wasm/issues/130
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: FIX
33
description: Use a more recent envoy for local deploy.
4-
issueLink: https://github.com/solo-io/wasme/issues/107
4+
issueLink: https://github.com/solo-io/wasm/issues/107
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
changelog:
22
- type: FIX
33
description: Fix a bug in version linking which caused the version to be 'dev' on release.
4-
issueLink: https://github.com/solo-io/wasme/issues/158
4+
issueLink: https://github.com/solo-io/wasm/issues/158

tools/wasme/cli/docs/content/tutorial_code/build_tutorials/building_assemblyscript_filters.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You'll be asked with an interactive prompt which language platform you are build
2727
```
2828

2929
```
30-
INFO[0014] extracting 1973 bytes to /Users/ilackarms/go/src/github.com/solo-io/wasme/assemblyscript-filter
30+
INFO[0014] extracting 1973 bytes to /Users/ilackarms/go/src/github.com/solo-io/wasm/assemblyscript-filter
3131
```
3232

3333
The `init` command will place our *base* filter into the `assemblyscript-filter` directory:
@@ -63,10 +63,10 @@ The new directory contains all files necessary to build and deploy a WASM filter
6363

6464
| File | Description |
6565
| ----- | ---- |
66-
| `assembly/index.ts` | The source code for the filter, written in AssemblyScript. |
67-
| `assembly/tsconfig.json` | Typescript config file (AssemblyScript is a subset of Typescript). |
68-
| `package.json` | Used by to import npm modules during build time. |
69-
| `package-lock.json` | Locked npm modules. |
66+
| `assembly/index.ts` | The source code for the filter, written in AssemblyScript. |
67+
| `assembly/tsconfig.json` | Typescript config file (AssemblyScript is a subset of Typescript). |
68+
| `package.json` | Used by to import npm modules during build time. |
69+
| `package-lock.json` | Locked npm modules. |
7070
| `runtime-config.json` | Config stored with the filter image used to load the filter at runtime. |
7171

7272
Open `assembly/index.ts` in your favorite text editor. The source code is AssemblyScript and we'll make some changes to customize our new filter.
@@ -90,7 +90,7 @@ Your method should look like this:
9090

9191
## Building the filter
9292

93-
Now, let's build a WASM image from our filter with `wasme`. The filter will be tagged and stored in a local registry, similar to how [Docker](https://www.docker.com/) stores images.
93+
Now, let's build a WASM image from our filter with `wasme`. The filter will be tagged and stored in a local registry, similar to how [Docker](https://www.docker.com/) stores images.
9494

9595
Images tagged with `wasme` have the following format:
9696

@@ -99,7 +99,7 @@ Images tagged with `wasme` have the following format:
9999
```
100100

101101
* `<registry address>` specifies the address of the remote OCI registry where the image will be pushed by the `wasme push` command. The project authors maintain a free public registry at `webassemblyhub.io`.
102-
102+
103103
* `<registry username|org>` either your username for the remote OCI registry, or a valid org name with which you are registered.
104104

105105

@@ -115,11 +115,11 @@ wasme build assemblyscript -t webassemblyhub.io/$YOUR_USERNAME/add-header:v0.1 .
115115
```
116116

117117
{{% notice note %}}
118-
`wasme build` runs a build container inside of Docker which may run into issues due to SELinux (on Linux environments). To disable, run `sudo setenforce 0`
118+
`wasme build` runs a build container inside of Docker which may run into issues due to SELinux (on Linux environments). To disable, run `sudo setenforce 0`
119119
{{% /notice %}}
120120

121-
The module will take up to a few minutes to build. In the background, `wasme` has launched a Docker container to run the necessary
122-
build steps.
121+
The module will take up to a few minutes to build. In the background, `wasme` has launched a Docker container to run the necessary
122+
build steps.
123123

124124
When the build has finished, you'll be able to see the image with `wasme list`:
125125

tools/wasme/cli/docs/content/tutorial_code/build_tutorials/building_cpp_filters.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Let's create a new filter called `cpp-filter`:
1616
wasme init cpp-filter
1717
```
1818

19-
You'll be asked with an interactive prompt which language platform you are building for. At time of writing, `wasme` includes separate bases
19+
You'll be asked with an interactive prompt which language platform you are building for. At time of writing, `wasme` includes separate bases
2020
for Istio 1.5.x and Gloo 1.3.x:
2121

2222
{{< tabs >}}
@@ -39,7 +39,7 @@ You'll be asked with an interactive prompt which language platform you are build
3939
{{< /tabs >}}
4040

4141
```
42-
INFO[0014] extracting 5072 bytes to /Users/ilackarms/go/src/github.com/solo-io/wasme/cpp-filter
42+
INFO[0014] extracting 5072 bytes to /Users/ilackarms/go/src/github.com/solo-io/wasm/cpp-filter
4343
```
4444

4545
The `init` command will place our *base* filter into the `cpp-filter` directory:
@@ -85,12 +85,12 @@ The new directory contains all files necessary to build and deploy a WASM filter
8585

8686
| File | Description |
8787
| ----- | ---- |
88-
| `BUILD` | The Bazel BUILD file used to build the filter. |
89-
| `WORKSPACE` | The Bazel WORKSPACE file used to build the filter. |
90-
| `bazel/` | Bazel external dependencies. |
91-
| `toolchain/` | Bazel tooling for building wasm modules. |
92-
| `filter.cc` | The source code for the filter, written in C++. |
93-
| `filter.proto` | The protobuf schema of the filter configuration. |
88+
| `BUILD` | The Bazel BUILD file used to build the filter. |
89+
| `WORKSPACE` | The Bazel WORKSPACE file used to build the filter. |
90+
| `bazel/` | Bazel external dependencies. |
91+
| `toolchain/` | Bazel tooling for building wasm modules. |
92+
| `filter.cc` | The source code for the filter, written in C++. |
93+
| `filter.proto` | The protobuf schema of the filter configuration. |
9494
| `runtime-config.json` | Config stored with the filter image used to load the filter at runtime. |
9595

9696
Open `filter.cc` in your favorite text editor. We'll make some changes to customize our new filter.
@@ -116,7 +116,7 @@ The code above will add the `hello: world!` header to HTTP responses processed b
116116
117117
## Building the filter
118118
119-
Now, let's build a WASM image from our filter with `wasme`. The filter will be tagged and stored in a local registry, similar to how [Docker](https://www.docker.com/) stores images.
119+
Now, let's build a WASM image from our filter with `wasme`. The filter will be tagged and stored in a local registry, similar to how [Docker](https://www.docker.com/) stores images.
120120
121121
Images tagged with `wasme` have the following format:
122122
@@ -125,7 +125,7 @@ Images tagged with `wasme` have the following format:
125125
```
126126
127127
* `<registry address>` specifies the address of the remote OCI registry where the image will be pushed by the `wasme push` command. The project authors maintain a free public registry at `webassemblyhub.io`.
128-
128+
129129
* `<registry username|org>` either your username for the remote OCI registry, or a valid org name with which you are registered.
130130
131131
@@ -141,11 +141,11 @@ wasme build cpp -t webassemblyhub.io/$YOUR_USERNAME/add-header:v0.1 .
141141
```
142142

143143
{{% notice note %}}
144-
`wasme build` runs a build container inside of Docker which may run into issues due to SELinux (on Linux environments). To disable, run `sudo setenforce 0`
144+
`wasme build` runs a build container inside of Docker which may run into issues due to SELinux (on Linux environments). To disable, run `sudo setenforce 0`
145145
{{% /notice %}}
146146

147-
The module will take up to a few minutes to build. In the background, `wasme` has launched a Docker container to run the necessary
148-
build steps.
147+
The module will take up to a few minutes to build. In the background, `wasme` has launched a Docker container to run the necessary
148+
build steps.
149149

150150
When the build has finished, you'll be able to see the image with `wasme list`:
151151

0 commit comments

Comments
 (0)