Skip to content

Commit 8396f0d

Browse files
authored
chore: discourage go install, update links (#1817)
- Discourages use of `go install` (see note in PR) - fixes some links --------- Signed-off-by: Todd Baert <[email protected]>
1 parent c12a0ae commit 8396f0d

File tree

4 files changed

+22
-21
lines changed

4 files changed

+22
-21
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,10 @@ MDL_CMD := docker run -v $(ROOT_DIR):/workdir --rm
119119

120120
.PHONY: markdownlint markdownlint-fix
121121
markdownlint:
122-
$(MDL_CMD) davidanson/markdownlint-cli2-rules:$(MDL_DOCKER_VERSION) "**/*.md"
122+
$(MDL_CMD) davidanson/markdownlint-cli2:$(MDL_DOCKER_VERSION) "**/*.md"
123123

124124
markdownlint-fix:
125-
$(MDL_CMD) --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2-rules:$(MDL_DOCKER_VERSION) "**/*.md"
125+
$(MDL_CMD) davidanson/markdownlint-cli2:$(MDL_DOCKER_VERSION) --fix "**/*.md"
126126

127127
.PHONY: pull-schemas-submodule
128128
pull-schemas-submodule:

docs/installation.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,12 @@ For more information, see [OpenFeature Operator](./reference/openfeature-operato
3232

3333
:fontawesome-brands-linux::fontawesome-brands-windows::fontawesome-brands-apple: Binaries are available in x86/ARM.
3434

35-
[Release](https://github.com/open-feature/flagd/releases)
35+
[Releases](https://github.com/open-feature/flagd/releases)
36+
37+
!!! note
38+
39+
Installing flagd with `go install github.com/open-feature/flagd/flagd@latest` is not recommended, because the module depends on potentially unpublished, local workspace modules.
40+
Please use one of the official, versioned binary releases above.
3641

3742
### systemd
3843

@@ -44,12 +49,6 @@ A systemd wrapper is available [here](https://github.com/open-feature/flagd/blob
4449
brew install flagd
4550
```
4651

47-
### Go binary
48-
49-
```shell
50-
go install github.com/open-feature/flagd/flagd@latest
51-
```
52-
5352
## Summary
5453

5554
Once flagd is installed, you can start using it within your application.

docs/reference/specifications/protos.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ FetchAllFlagsResponse is the server response containing feature flag configurati
336336

337337
| Field | Type | Label | Description |
338338
| ----- | ---- | ----- | ----------- |
339-
| flag_configuration | [string](#string) | | flagd feature flag configuration. Must be validated to schema - https://raw.githubusercontent.com/open-feature/schemas/main/json/flagd-definitions.json |
339+
| flag_configuration | [string](#string) | | flagd feature flag configuration. Must be validated to schema - https://raw.githubusercontent.com/open-feature/flagd-schemas/main/json/flags.json |
340340

341341

342342

@@ -357,6 +357,7 @@ GetMetadataRequest is the request for retrieving metadata from the sync service
357357

358358
### GetMetadataResponse
359359
GetMetadataResponse contains metadata from the sync service
360+
DEPRECATED; use flagd.sync.v1.SyncFlagsResponse.sync_context
360361

361362

362363
| Field | Type | Label | Description |
@@ -393,7 +394,8 @@ SyncFlagsResponse is the server response containing feature flag configurations
393394

394395
| Field | Type | Label | Description |
395396
| ----- | ---- | ----- | ----------- |
396-
| flag_configuration | [string](#string) | | flagd feature flag configuration. Must be validated to schema - https://raw.githubusercontent.com/open-feature/schemas/main/json/flagd-definitions.json |
397+
| flag_configuration | [string](#string) | | flagd feature flag configuration. Must be validated to schema - https://raw.githubusercontent.com/open-feature/flagd-schemas/main/json/flags.json |
398+
| sync_context | [google.protobuf.Struct](#google-protobuf-Struct) | optional | Static context to be included in in-process evaluations (optional). |
397399

398400

399401

docs/reference/sync-configuration.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ See [syncs](../concepts/syncs.md) for a conceptual overview.
1111
Any URI passed to flagd via the `--uri` (`-f`) flag must follow one of the 6 following patterns with prefixes to ensure that
1212
it is passed to the correct implementation:
1313

14-
| Implied Sync Provider | Prefix | Example |
15-
| --------------------- | ---------------------- | ------------------------------------- |
16-
| `kubernetes` | `core.openfeature.dev` | `core.openfeature.dev/default/my-crd` |
17-
| `file` | `file:` | `file:etc/flagd/my-flags.json` |
18-
| `http` | `http(s)://` | `https://my-flags.com/flags` |
19-
| `grpc` | `grpc(s)://` | `grpc://my-flags-server` |
14+
| Implied Sync Provider | Prefix | Example |
15+
| ------------------------------------- | ---------------------------------- | ------------------------------------- |
16+
| `kubernetes` | `core.openfeature.dev` | `core.openfeature.dev/default/my-crd` |
17+
| `file` | `file:` | `file:etc/flagd/my-flags.json` |
18+
| `http` | `http(s)://` | `https://my-flags.com/flags` |
19+
| `grpc` | `grpc(s)://` | `grpc://my-flags-server` |
2020
| &nbsp;[grpc](#custom-grpc-target-uri) | `[ envoy \| dns \| uds\| xds ]://` | `envoy://localhost:9211/test.service` |
21-
| `gcs` | `gs://` | `gs://my-bucket/my-flags.json` |
22-
| `azblob` | `azblob://` | `azblob://my-container/my-flags.json` |
23-
| `s3` | `s3://` | `s3://my-bucket/my-flags.json` |
21+
| `gcs` | `gs://` | `gs://my-bucket/my-flags.json` |
22+
| `azblob` | `azblob://` | `azblob://my-container/my-flags.json` |
23+
| `s3` | `s3://` | `s3://my-bucket/my-flags.json` |
2424

2525
### Data Serialization
2626

@@ -58,7 +58,7 @@ Alternatively, these configurations can be passed to flagd via config file, spec
5858
| providerID | optional `string` | Value binds to grpc connection's providerID field. gRPC server implementations may use this to identify connecting flagd instance |
5959
| selector | optional `string` | Value binds to grpc connection's selector field. gRPC server implementations may use this to filter flag configurations |
6060
| certPath | optional `string` | Used for grpcs sync when TLS certificate is needed. If not provided, system certificates will be used for TLS connection |
61-
| maxMsgSize | optional `int` | Used for gRPC sync to set max receive message size (in bytes) e.g. 5242880 for 5MB. If not provided, the default is [4MB](https://pkg.go.dev/google.golang.org#grpc#MaxCallRecvMsgSize) |
61+
| maxMsgSize | optional `int` | Used for gRPC sync to set max receive message size (in bytes) e.g. 5242880 for 5MB. If not provided, the default is [4MB](https://pkg.go.dev/google.golang.org#grpc#MaxCallRecvMsgSize) |
6262

6363
The `uri` field values **do not** follow the [URI patterns](#uri-patterns). The provider type is instead derived
6464
from the `provider` field. Only exception is the remote provider where `http(s)://` is expected by default. Incorrect

0 commit comments

Comments
 (0)