apache / apache/maka

docs: apply Apache Incubator branding to release surfaces

Open
#3,272 2 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
TypeScript
Stars
5.4k
Forks
502
Avg merge
1d 2h
Merged PRs (30d)
715

Description

English

Part of #2974 — G5: Incubator branding and release surfaces.

## Outcome

Make repository and release-facing surfaces consistently identify the project
as Apache Maka (Incubating) and provide the disclaimer, source download, and
release-verification paths required for the source, npm, and Desktop artifacts.

## Exit criteria

- [x] Root English and Chinese READMEs first identify Apache Maka and its
incubating status and link the disclaimer. Done in #3391.
- [x] Repository description and metadata use Apache Incubator branding. The
description landed in #3262; #3391 added the missing `incubator` topic.
- [ ] `maka.apache.org` serves the reviewed project website rather than 404.
- [ ] The website provides an ASF-compliant source download path and points to
`KEYS` and verification instructions.
- [ ] The npm package README/version page displays the full Incubator disclaimer
and links the approved source release.
- [ ] GitHub release surfaces distinguish ASF releases from historical or
non-ASF product releases, carry the required Incubator disclaimer, and link
each Desktop convenience artifact to the approved source release.
- [ ] The release announcement and download page use the approved project name
and distinguish the official source release from npm/Desktop convenience
artifacts.

## Existing work

- #3391 identified both root READMEs as Apache Maka (Incubating), linked
`DISCLAIMER-WIP`, added the source-release versus convenience-artifact framing
and the ASF trademark attribution, removed the prebuilt download
recommendation that pointed at an unapproved build, and added the `incubator`
topic.
- #3404 tracks `maka.apache.org`, which covers the website and source download
criteria above.
- #3262 directly covers `.asf.yaml` and repository metadata, but only part of
this gate.
- #2924 targets the pre-Apache website and should not be merged as-is. It is
historical context, not a closing PR for this issue.

## Out of scope

- Product website redesign unrelated to Apache release requirements.
- npm/Desktop packaging and licensing implementation.
- Export classification.

## References

- [Incubator branding guide](https://incubator.apache.org/guides/branding.html)
- [Incubator distribution guidelines](https://incubator.apache.org/guides/distribution.html)

## Ownership

Leave the overall issue unassigned until someone claims all release surfaces.
The author of #3262 remains responsible only for that PR's explicit scope.

简体中文

#2974 的一部分——G5:孵化器品牌与发版界面。

## 目标结果

让仓库和面向发版的界面一致标识项目为 Apache Maka (Incubating),并提供第一次发版
所需的免责声明,以及源码、npm 和 Desktop artifacts 的下载与验包入口。

## 完成条件

- [x] 根目录英文和中文 README 首次提及时使用 Apache Maka 及其 incubating 状态,
并链接免责声明。已由 #3391 完成。
- [x] 仓库描述和元数据使用 Apache Incubator 品牌。描述由 #3262 落地,#3391 补上缺失的
`incubator` topic。
- [ ] `maka.apache.org` 提供经过审查的项目网站,不再返回 404。
- [ ] 网站提供符合 ASF 要求的源码下载入口,并链接 `KEYS` 和验包说明。
- [ ] npm package README/version 页面展示完整 Incubator disclaimer,并链接获批源码
release。
- [ ] GitHub release 界面区分 ASF release 与历史/非 ASF 产品版本,并携带所需的
Incubator disclaimer,同时将每个 Desktop convenience artifact 链接到获批源码
release。
- [ ] 发版公告和下载页使用批准的项目名称,并区分官方源码 release 与 npm/Desktop
convenience artifacts。

## 已有工作

- #3262 直接覆盖 `.asf.yaml` 和仓库元数据,但只完成这一 gate 的一部分。
- #3391 已让两个根 README 标识为 Apache Maka (Incubating)、链接 `DISCLAIMER-WIP`、
补上源码 release 与 convenience artifact 的区分和 ASF 商标声明,移除了指向未获批构建
的预构建下载推荐,并补上 `incubator` topic。
- #3404 跟踪 `maka.apache.org`,覆盖上面的网站与源码下载两条完成条件。
- #2924 面向进入 Apache 前的网站,不应原样合并。它只是历史背景,不能关闭本 issue。

## 不在范围内

- 与 Apache 发版要求无关的产品网站重新设计。
- npm/Desktop 打包和许可证实现。
- Export classification。

## 参考资料

- [Incubator 品牌指南](https://incubator.apache.org/guides/branding.html)
- [Incubator 分发指南](https://incubator.apache.org/guides/distribution.html)

## 负责人边界

在有人认领全部发版界面前,整个 issue 保持 unassigned。#3262 author 只负责该 PR 明确
声明的范围。

Contributor guide

Open the contributing guide

Research direction

Start with the Incubator branding and distribution guides, then review the root READMEs, .asf.yaml, npm package README/version page, GitHub release surfaces, and the website tracked by #3404. Map the remaining unchecked exit criteria while keeping #3391, #3262, and #3404 scopes separate. Done means every unchecked release-surface criterion is satisfied without including out-of-scope packaging or website redesign work.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation, release
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.