Skip to content

docs: identify the project as Apache Maka (Incubating) in both READMEs - #3391

Merged
Astro-Han merged 2 commits into
mainfrom
docs/incubator-branding-readme
Aug 22, 2026
Merged

docs: identify the project as Apache Maka (Incubating) in both READMEs#3391
Astro-Han merged 2 commits into
mainfrom
docs/incubator-branding-readme

Conversation

@Astro-Han

@Astro-Han Astro-Han commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Summary

The root READMEs opened as "Maka", with no incubation status and no link from the repository front page to DISCLAIMER-WIP. This applies Incubator branding to the two surfaces whose wording does not depend on the undecided first-release scope.

Refs #3272

Scope: why this is not Fixes #3272

Four of the seven exit criteria in #3272 depend on decisions that are not mine to make, so this PR deliberately stops short of them.

#3272 exit criterion This PR
Root English and Chinese READMEs first identify Apache Maka and its incubating status and link the disclaimer Satisfied
Repository description and metadata use Apache Incubator branding Satisfied — description landed in #3262, topic added here
maka.apache.org serves the reviewed project website rather than 404 Not attempted — needs Infra configuration and PPMC review of website content; see "Follow-up" below
The website provides an ASF-compliant source download path and points to KEYS and verification instructions Not attempted — depends on the website existing
npm package README/version page displays the full disclaimer and links the approved source release Not attempted — depends on whether npm is in first-release scope (#2974, #3275)
GitHub release surfaces distinguish ASF releases from historical or non-ASF product releases Not attempted — overlaps the pending mentor decision in #3274
The release announcement and download page use the approved project name Not attempted — no release candidate exists yet

The README wording states the source-versus-convenience-artifact distinction in general terms and does not assert that npm or Desktop artifacts are part of the first release. That remains a PPMC and mentor decision under #2974.

Prior art

Wording and structure follow Apache OpenDAL. The trademark line is OpenDAL's site-footer sentence with the project name substituted. The source-versus-convenience-artifact framing matches OpenDAL's download page, which states that official releases are provided as source artifacts and keeps verification against KEYS, GPG, and SHA-512 next to the download links.

The Chinese README marks DISCLAIMER-WIP as authoritative in English rather than translating the disclaimer as a substitute for it.

Verification

  • npm run format — clean, no fixes applied.
  • .asf.yaml round-tripped through the strictyaml check from chore: add .asf.yaml for ASF infrastructure self-service #3262 (dirty_loadas_yaml()dirty_load): prints 184 184 OK, so the folded description scalar is unpolluted, and the parsed label list contains the new incubator topic.
  • Verified against gh api repos/apache/maka that the live description already carries the incubating name and that incubator is genuinely absent from the current topics.
  • Checked that no script or test asserts README content: the matches under scripts/ are release-packaging code and asf-source-release.test.mjs fixtures that write their own README.md.
  • Not run: typecheck, build, and the workspace suites. This PR touches two Markdown files and .asf.yaml; none of those suites cover them.
  • .asf.yaml label reconciliation itself can only be verified after merge, when asfyaml processes the change.

AI use

Select exactly one:

  • No generative tool made a substantive contribution
  • Generative tooling made a substantive contribution

Tool(s) and scope: Claude Code drafted the README changes, the .asf.yaml topic, this description, and ran the verification above. The human contributor reviews the final diff and owns the decision to submit it. The commit carries a Generated-by: Claude Code trailer.

Checklist

  • Tests cover the change and fail without it
  • Lint and format pass locally; typecheck and the test suites do not cover Markdown or .asf.yaml and were not run

Does this PR entail a change in behavior?

  • Yes — described under Summary above
  • No

The root READMEs still opened as "Maka" with no incubation status and no
path from the repository front page to DISCLAIMER-WIP, so the first surface
a reader or a release reviewer sees did not identify the project by its
podling name.

Rename both README titles to Apache Maka (Incubating), carry the standard
ASF incubation disclaimer text near the top of each file, and link
DISCLAIMER-WIP as the current record of known issues.

Add a "Releases and downloads" section ahead of the existing download
instructions. It states that no Apache release exists yet, that what is
published today is not an ASF release and has not been through an Incubator
PMC vote, and that once Apache releases exist the source release published
by the ASF is the release while packages built from it and distributed
elsewhere are convenience artifacts. The section deliberately does not say
which convenience artifacts belong to the first release; that scope is a
PPMC and mentor decision.

Add the ASF trademark attribution to the license section of each README,
using the wording Apache OpenDAL carries in its site footer.

Add the `incubator` topic to `.asf.yaml`, extending the repository metadata
that #3262 established. The description there already carries the
incubating name; the topic list carried `apache` but not `incubator`.

Advances #3272. It does not close it: `maka.apache.org`, the npm
package page, the GitHub release surfaces, and the announcement remain
open, and several of those depend on the undecided first-release scope.

Generated-by: Claude Code

@jackwener jackwener left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review of exact head 3e4ebfdfa60dfba8450c835beef7af9e7ea6b4c2.

The current main README still lacks the complete Incubator identification, disclaimer link, source-release/convenience-artifact framing, and trademark attribution. This patch adds those narrowly in both root READMEs and adds the missing incubator repository topic. The English and Chinese wording is internally consistent, links point at tracked policy files, and I found no P0-P2 defect. Required test is green on this exact head.

Merge readiness: not ready yet because repository protection still requires an independent human review. Given that this is ASF governance/branding language, the reviewing human should be a maintainer/PPMC member or mentor who can validate the policy wording, not merely the Markdown mechanics.

@Astro-Han

Copy link
Copy Markdown
Contributor Author

Thanks for the review.

Agreed on merge readiness, and no changes are needed from this pass. Recording the intent behind two wording choices so a policy reviewer can check them quickly:

  • The identification text, the source-release vs. convenience-artifact framing, and the trademark attribution follow Apache OpenDAL, which our mentors asked us to mirror.
  • The Chinese README carries the same statements, with DISCLAIMER-WIP marked as authoritative in English.

Leaving this open for a maintainer/PPMC member or mentor to validate the policy language, as you note. Refs #3272 — this PR covers the README identification and repository metadata criteria only; the website work is tracked in #3404.

@hqhq1025 hqhq1025 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed exact head 3e4ebfdfa60dfba8450c835beef7af9e7ea6b4c2.

Verdict: not ready to merge.

The primary problem is real and correctly scoped: the repository README must identify the podling as Apache Maka (Incubating), carry the Incubator disclaimer, link the project disclaimer, and expose appropriate ASF trademark attribution. The title, standard disclaimer text, Chinese authoritative-link treatment, trademark line, and incubator topic are all directionally sound.

One distribution-policy blocker remains in the new releases/downloads presentation. The Incubator vote accepted Maka on August 13, 2026, but the README’s /releases/latest target is v0.1.11, published on August 18 as a normal Latest release. Its release page has no Incubator disclaimer, and this PR itself states that no IPMC-approved Apache source release exists. Incubator distribution guidance requires convenience binaries to be built from an IPMC-approved ASF source release, requires GitHub releases to carry the incubation disclaimer, and says pre-incubation releases must be clearly described and tagged as such.

The new section therefore says the current artifact is not an ASF release and then immediately promotes it as the current Desktop download. A README disclaimer does not make an unapproved post-incubation binary a valid convenience artifact.

First principles / Occam: until an approved source release exists or the IPMC explicitly permits an exception, remove the active /releases/latest download recommendation and describe existing artifacts only as historical/non-ASF where that is factually true. The GitHub release surfaces still need their separately tracked remediation, but this README should not direct new users to a known-unapproved Latest artifact.

Verification:

  • exact-head CI is green and GitHub reports the PR mergeable;
  • the three-file diff is mechanically clean and all relative links resolve;
  • live GitHub metadata confirms v0.1.11 is non-prerelease Latest, published August 18, 2026, with no incubation disclaimer;
  • the Incubator acceptance result is dated August 13, 2026.

Required conclusions:

  • Problem definition: correct for repository identification, incomplete for the download surface the patch edits.
  • First principles / Occam: not yet; branding and distribution eligibility must agree.
  • Optimality: no while the README promotes an artifact it labels unapproved.
  • Production code to delete: none.
  • Tests to delete or replace: none; this is a policy/content defect, not a test defect.
  • Deeper refactor: no.
  • Merge readiness: no.
  • Residual risk: npm and GitHub release pages remain outstanding under #3272 even after the README is corrected.

Policy references:

Comment thread README.md
The READMEs stated that nothing published so far is an Apache release, then
directed users to the floating /releases/latest download on the next line. That
target is v0.1.11, published on 2026-08-18 after the Incubator accepted Maka on
2026-08-13, as a non-prerelease Latest with no incubation disclaimer.

Incubator distribution guidance requires convenience binaries to be built from
an IPMC-approved ASF source release. Until such a release exists, the READMEs
recommend no prebuilt download and point at the existing from-source path. The
platform support facts and the Windows preview caveat are kept as a single
statement in the releases section.

Generated-by: Claude Code
@Astro-Han
Astro-Han requested a review from hqhq1025 August 22, 2026 06:53
@Astro-Han

Copy link
Copy Markdown
Contributor Author

Pushed 17f013eb7 for the P1.

Both READMEs no longer recommend a prebuilt download: the Download Desktop for macOS and Windows x64 preview sections are removed, and the releases section now states that no prebuilt download is recommended until an IPMC-approved source release exists, then points at the existing from-source path. The platform-support facts (Apple Silicon only, Windows still an unsigned preview) are kept as one statement, and docs/windows-support.md is still linked for the preview details.

The v0.1.11 release page is left as is. Per PPMC that is not a blocker for this PR and will be handled separately, together with the remaining npm and GitHub release surfaces tracked under #3272.

@hqhq1025 re-requested for review.

@hqhq1025 hqhq1025 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed exact head 17f013eb788385fa4ef4fdebb67e06e21372576b.

The previous distribution-policy finding is resolved. Both READMEs now stop recommending /releases/latest or any other prebuilt download until an IPMC-approved source release exists, and direct users to the existing source-build path instead. The retained platform statement accurately distinguishes the supported Apple Silicon development target from the unsigned Windows preview.

The PR now cleanly solves its stated problem: the repository front page identifies Apache Maka as incubating, includes the standard disclaimer and DISCLAIMER-WIP link, explains the source-release/convenience-artifact boundary without promoting an ineligible artifact, adds the ASF trademark attribution, and adds the incubator repository topic. The English and Chinese versions remain semantically aligned.

First-principles / Occam assessment: the implementation is narrowly scoped and uses the README as the correct ownership surface for first-contact project and release status. No deeper refactor is needed. No production code or tests should be deleted or replaced.

Verification: git diff --check passed; .asf.yaml parsed successfully with the incubator label present; all referenced relative targets exist; the merge tree showed no conflicts; GitHub reports the PR mergeable; and the required test workflow completed successfully on this exact head, including lint, format, build, release contracts, typecheck, workspace tests, Runtime Host tests, Desktop E2E, Storybook smoke, and installed CLI release validation.

Merge verdict: ready to merge. Remaining remediation of historical GitHub release and npm surfaces is explicitly tracked under #3272 and does not require this README-focused PR to expand its scope.

@Astro-Han
Astro-Han merged commit 7994a4d into main Aug 22, 2026
1 check passed
@Astro-Han
Astro-Han deleted the docs/incubator-branding-readme branch August 22, 2026 07:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants