fix(docs): align quick-start OTLP port - #438
Open
AnxForever wants to merge 1 commit into
Open
Conversation
Document the proxy's port 4000 default in both quick-start guides and add a repository contract test that derives the expected port from its env example. Fixes superloglabs#397
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
Align both quick-start guides with the proxy's actual default port (
4000). The previous4101URLs sent new contributors to a port where the OTLP proxy does not listen.The new repository contract test derives the expected port from
apps/proxy/.env.example, so future runtime-default changes must update the public setup instructions too.Fixes #397
How to test
pnpm test:repository-contractspnpm test:ci-workflowspnpm typecheckpnpm exec biome check scripts/quick-start-defaults.test.ts package.jsonAI assistance
Type of change
Checklist
pnpm typecheckpassespnpm lintpasses (currentmainhas unrelated existing Biome diagnostics; all changed Biome-supported files pass targeted checks)pnpm formathas been run on changed filesmainSummary by cubic
Fixes quick-start docs that pointed OTLP traffic to port 4101 by aligning them to the proxy’s actual default port, 4000. Adds a repository contract test and CI check to keep docs in sync with
apps/proxy/.env.example. Fixes #397.README.mdandCONTRIBUTING.mdto usehttp://localhost:4000for the OTLP proxy.scripts/quick-start-defaults.test.tsand atest:repository-contractsscript; CI now runs it to ensure docs match the port inapps/proxy/.env.example.Written for commit 983e957. Summary will update on new commits.