Skip to content

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

Open
Astro-Han wants to merge 1 commit into
mainfrom
docs/incubator-branding-readme
Open

docs: identify the project as Apache Maka (Incubating) in both READMEs#3391
Astro-Han wants to merge 1 commit 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.

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.

2 participants