docs: drop the last "OSS" references from the current docs - #912
Merged
Merged
Conversation
#911 made every user-facing page describe one binary, keploy, with no edition vocabulary. Four engineering pages still said "the OSS replayer" and "the OSS `config.Record` struct", and the k8s-proxy LLM workflow called `keploy record` "the local OSS command". They are describing the replayer package (the import path is unchanged and still names it) rather than telling a reader which build to install, which is why they survived the first pass — but the convention is that the docs do not make the reader sort out editions anywhere. Signed-off-by: slayerjain <shubham@keploy.io>
slayerjain
added a commit
that referenced
this pull request
Sep 23, 2026
Every deploy ran reggionick/s3-deploy with delete-removed: upload the new build, then delete every object it did not contain. Docusaurus names each JS/CSS chunk by content hash, so the previous build's chunks vanished the moment a deploy ran, and anything still holding the previous HTML - an open tab, a cached page, or a second deploy running at the same time - requested chunks that no longer existed and never hydrated. Two merges 17s apart (#912, #913) did exactly that to production: the pages rendered but no control on them worked, including the macOS tab on /docs/server/installation/. The action's cache input was also word-split into the malformed header "Cache-Control: max-age=public," on every object. - main.yml: one deploy at a time (concurrency group, never cancelling a deploy in flight), and each run deploys main as it is when it starts, so a queued, cancelled or re-run deploy can never ship an older main. - .github/scripts/deploy-docs.sh replaces the action. Hashed assets go up first and are never deleted in the same pass; a per-deploy manifest is written before any page; static files, text and pages follow, pages last; CloudFront is invalidated, dropped static files are deleted once it has landed, and the deploy is marked complete. Assets are pruned only once every page that used them was replaced more than 14 days ago, counted from the newest completed deploy, so a half-failed deploy can never cut the window short. - Correct cache headers per class: immutable for hashed assets, revalidate for pages and text, one hour for other static files; UTF-8 charset on .txt and .md (llms.txt, llms-full.txt, page copies). - .github/scripts/deploy-docs-test.sh deploys the PR's real build into a local S3 (moto) on every PR and replays the incident and the weeks after it: a deploy that dies once its pages are up, >1000-key prunes, every asset a live or still-open page loads, and the step order. Signed-off-by: slayerjain <shubhamkjain@outlook.com>
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
1 participant
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.
Follow-up to #911, which made every user-facing page describe one binary — keploy — with no edition vocabulary.
Six references survived that pass, in engineering pages rather than install guides:
running-keploy/k8s-proxy-daemonset-architecture.md— "the OSS replayer" ×4, including one inside the dispatch diagramrunning-keploy/k8s-proxy-api.md— "a UI-friendly subset of the OSSconfig.Recordstruct"quickstart/k8s-proxy-llm-workflow.md— "keploy recorditself is the local OSS command"They describe the replayer package rather than telling a reader which build to install, which is why they were not caught the first time — but the convention is that docs never ask the reader to sort out editions. The import path
go.keploy.io/server/v3/pkg/service/replayis left exactly as it is; it is a real symbol, not a product name.grep -rE '\bOSS\b|--oss|open-source build' versioned_docs/version-4.0.0is now empty. Prettier clean.