fix(compliance): verbatim LF trademark statement, plus the 2.0.0 terminology audit corrections - #13
Merged
Merged
Conversation
…mark The intro page footer carried the valkey.io sentence "Valkey and the Valkey logo are trademarks of LF Projects, LLC." The ACP component compliance rules require a specific two-paragraph statement, reproduced verbatim in English, and the ® symbol at the first usage of the mark. The operator listing fields were corrected for the same reason; this brings the documentation site in line with them, byte for byte. The statement goes in a `## Trademarks` section on the intro page rather than a site-wide footer: doom passes `themeConfig` through to rspress, but rspress renders `footer.message` only in HomeFooter, and this site has no home layout. The Chinese site is machine-translated at build time, and the previous build translated the statement and dropped the English paragraphs entirely, which the rules do not allow. The page now carries an `i18n.additionalPrompts` instruction that keeps the English verbatim and appends the Chinese rendering already shipped in the listing, copied rather than re-translated, so the two surfaces cannot drift. That path is verified by reading the translator's prompt assembly, not by running it; the published Chinese page still needs a check after release. The three authoring policies under agent/ prescribed the superseded sentence and the ™ symbol, so new text would have reproduced them.
A terminology review of all 35 pages against agent/TERMINOLOGY.md returned one finding that changes what an operator does, three that remove ambiguity, and one house-style call. The replication credential directive is not spelled the same on every supported server line. Three passages told the reader that `CONFIG GET` redacts a set `requirepass` or `primaryauth` value, with no version qualifier. On 7.2 the directive is registered as `masterauth` with no alias; only 8.1 and 9.1 register `primaryauth`, with `masterauth` as its alias. A 7.2 operator following those passages to confirm that replication credentials are not exposed queries a directive that does not exist on their line and reads the empty result as "nothing set", while the credential is in fact held by `masterauth`. All three passages now name the directive per line, and the evidence is recorded in agent/ARCHITECTURE_FACTS.md so a later edit cannot drop the version scope. The remaining corrections: - "node" is reserved for Kubernetes nodes. Four places used it for a Valkey process on pages that also discuss scheduling, anti-affinity, and node selectors, where the word means a machine. - "cross-cluster" is qualified as "cross-Kubernetes-cluster". Unqualified, in a product whose architecture is named Cluster, it can be read as replication across the shards of a Valkey Cluster. - Navigation labels: "Troubleshooting" is one word, and the two guide sections are now distinguished in English the way the Chinese labels already were. - Standard protocol and standards-body names are written as the proper names they are: RFC 3339, IPv4, IPv6, IP family. The rule is recorded in agent/TECHNICAL_WRITING_POLICY.md, naming both the abbreviations that are expanded at first use and those that never are, because the mechanical scan flags an unexpanded acronym and would otherwise drive a revert. One reported finding was withdrawn rather than applied. It claimed the forbidden-directive list omitted `ignore-warnings`; that entry is commented out in internal/builder/config.go and is therefore not filtered. The documented list matches the 39 active entries in membership and order, so the change would have introduced the error it claimed to fix.
Deploying alauda-valkey with
|
| Latest commit: |
ad185ae
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d34eafb5.alauda-valkey.pages.dev |
| Branch Preview URL: | https://fix-trademark-statement.alauda-valkey.pages.dev |
Collaborator
Author
|
Paired with #14, which cherry-picks both commits onto |
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.
Two independent changes, one commit each. Review them separately.
1. Trademark statement (
1223e1d)The intro page carried the valkey.io sentence "Valkey and the Valkey logo are trademarks of LF Projects, LLC." The ACP component compliance rules require a specific two-paragraph statement reproduced verbatim in English, plus
®at the first usage of the mark. The operator listing fields were corrected for the same reason and merged torelease-2.0; this brings the documentation site in line with them, byte for byte.Three points worth reviewer attention:
themeConfigthrough to rspress, but rspress rendersfooter.messageonly inHomeFooter, and this site has no home layout. A per-page footer would mean overridingtheme/index.ts. If the compliance owner insists on every page, that is the follow-up.i18n.additionalPromptsinstruction that keeps the English verbatim and appends the Chinese rendering already shipped in the listing, copied rather than re-translated, so the two surfaces cannot drift apart on each build.temperature: 0.2that doom hardcodes, and the shared gateway rejected the key. doom's prompt template also ranks its baseline instructions above additional ones, so the instruction can be ignored by the model. Someone must check the published Chinese intro page after release. A proper no-translate marker in doom would remove the doubt; worth raising upstream.The three authoring policies under
agent/prescribed the superseded sentence and the™symbol, so new text would have reproduced them.2. Terminology corrections (
ad185ae)A terminology review of all 35 pages against
agent/TERMINOLOGY.md, with every identifier verified against the operator atrelease-2.0and the container source pinned by its image tags.The one finding that changes what an operator does. Three passages told the reader that
CONFIG GETredacts a setrequirepassorprimaryauthvalue, with no version qualifier. On 7.2 the directive is registered asmasterauthwith no alias; only 8.1 and 9.1 registerprimaryauth, withmasterauthas its alias:A 7.2 operator following those passages to confirm that replication credentials are not exposed queries a directive that does not exist on their line and reads the empty result as "nothing set, nothing to check", while the credential is in fact held by
masterauth. The redaction itself works on all three lines, so nothing unsafe is configured; the verification simply fails silently on one third of the supported matrix. All three passages now name the directive per line, and the evidence is recorded inagent/ARCHITECTURE_FACTS.md.The remaining corrections remove ambiguity rather than change a conclusion:
Troubleshooting,How-to guides,Feature guidesRFC 3339,IPv4,IPv6,IP familyThe abbreviation rule is recorded in
agent/TECHNICAL_WRITING_POLICY.md, naming both the abbreviations expanded at first use (ACL, PVC, CRD, CA) and those never expanded, because the mechanical scan flags an unexpanded acronym and would otherwise drive a revert.One reported finding was withdrawn rather than applied. It claimed the forbidden-directive list omitted
ignore-warnings. That entry is commented out ininternal/builder/config.goand is therefore not filtered at all; the documented list matches the 39 active entries in both membership and order. Applying the recommendation would have introduced the error it claimed to fix.Verification
yarn lint— 0 errors, 0 warnings.yarn build— no warnings. The## Trademarkssection reaches the rendered page,llms-full.txt, and the search index, byte-identical to the merged listing. All three per-line credential sentences and the three new navigation labels render correctly. The translation instruction does not leak into output.data-node,node recovery, barecross-cluster,Request for Comments,Internet Protocol.After merge
Cherry-pick both commits to
release-2.0, which is what builds the live 2.0 site, then check the published Chinese intro page.🤖 Generated with Claude Code