Merge pull request #84 from intergral/docs_build

fix(docs): typo in docs

.github/workflows/on_push.yml

@@ -80,12 +80,6 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v4
 
-      - name: Install Protoc
-        uses: arduino/setup-protoc@v1
-        with:
-          version: '3.11.2'
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-
       - name: Check vendor
         run: make vendor-check
 

docs/docs/_sections/bug_report.md

@@ -1,5 +1,5 @@
 # Report Issues
 
 If there are any errors that have been reported in the logs, or you are experiencing strange behaviour please create an
-issue on the [Github](https://github.com/intergral/deep/issues/new/choose) project. This will allow us to improve Deep
+issue on the [GitHub](https://github.com/intergral/deep/issues/new/choose) project. This will allow us to improve Deep
 and hopefully help you resolve your issues.  

docs/docs/features/metrics.md

@@ -38,7 +38,7 @@ The specific supported providers is dependent on the client that is being used.
 using the plugin architecture of the client. As a generalisation the following providers will be detected and used automatically:
 
  - Prometheus
- - Otel
+- OpenTelemarty (OTel)
 
 For more info on what providers are supported by which clients see the client docs.
 

docs/docs/features/traces.md

@@ -27,7 +27,7 @@ allows for '[method entry tracepoints](./method_entry.md)'
 The specific supported providers is dependent on the client that is being used. In all cases custom providers can be set
 using the plugin architecture of the client. As a generalisation the following providers will be detected and used automatically:
 
-- Otel
+- OpenTelemarty (OTel)
 
 For more info on what providers are supported by which clients see the client docs.
 

modules/ingester/ingester_test.go

@@ -336,6 +336,8 @@ func TestFlush(t *testing.T) {
 		require.NoError(t, err, "unexpected error querying")
 		assert.True(t, proto.Equal(snapshots[i], foundSnapshot.Snapshot), "Snapshots not equal")
 	}
+	// Stop the ingester to stop it writing to disk between now and temp dir delete
+	require.NoError(t, ingester.stopping(nil))
 }
 
 func defaultIngesterModule(t testing.TB, tmpDir string) *Ingester {

modules/ingester/instance_search_test.go

@@ -24,6 +24,7 @@ import (
 	"fmt"
 	"sort"
 	"strconv"
+	"sync"
 	"sync/atomic"
 	"testing"
 	"time"
@@ -333,8 +334,11 @@ func TestInstanceSearchDoesNotRace(t *testing.T) {
 	}
 
 	end := make(chan struct{})
+	group := sync.WaitGroup{}
 
 	concurrent := func(f func()) {
+		group.Add(1)
+		defer group.Done()
 		for {
 			select {
 			case <-end:
@@ -418,6 +422,7 @@ func TestInstanceSearchDoesNotRace(t *testing.T) {
 	close(end)
 	// Wait for go funcs to quit before
 	// exiting and cleaning up
+	group.Wait()
 	time.Sleep(2 * time.Second)
 }
 

modules/ingester/tenantBlockManager_test.go

@@ -21,6 +21,7 @@ import (
 	"context"
 	crand "crypto/rand"
 	"encoding/binary"
+	"sync"
 	"testing"
 	"time"
 
@@ -173,8 +174,11 @@ func queryAll(t *testing.T, i *tenantBlockManager, ids [][]byte, snapshots []*de
 func TestInstanceDoesNotRace(t *testing.T) {
 	i, ingester := defaultInstance(t)
 	end := make(chan struct{})
+	group := sync.WaitGroup{}
 
 	concurrent := func(f func()) {
+		group.Add(1)
+		defer group.Done()
 		for {
 			select {
 			case <-end:
@@ -225,6 +229,7 @@ func TestInstanceDoesNotRace(t *testing.T) {
 	close(end)
 	// Wait for go funcs to quit before
 	// exiting and cleaning up
+	group.Wait()
 	time.Sleep(2 * time.Second)
 }