+1 GitHub Wiki. On Thursday, April 3, 2025, Ed Espino <esp...@apache.org> wrote:
> Hi Dianjing and Cloudberry community, > > Thanks for initiating this discussion—organizing our collective knowledge > more effectively is a great idea. > > I’d like to voice my support for *Option 1: GitHub Wiki*. > > - > > *Markdown-native*: GitHub Wiki uses Markdown, which is the de facto > standard for many open-source documentation efforts. It's easy to read, > version control friendly, and aligns well with our existing workflows. > - > > *Familiarity and ease of access*: Most PPMC members, contributors, and > potential new collaborators are already deeply familiar with GitHub. > Keeping documentation discoverable and editable in the same interface as > our source code lowers the barrier to contribution. > - > > *Lightweight and flexible*: For scattered artifacts like design notes, > community event logs, and proposal drafts, GitHub Wiki offers a more > fluid > and informal space than the main site or ASF Confluence. > - > > *Lower friction for updates*: Contributors can quickly add or edit > content without needing to navigate the more structured (and sometimes > heavyweight) ASF Confluence interface. > > While ASF Confluence has its strengths (especially for larger, structured > documentation sets), I believe starting with GitHub Wiki offers the most > pragmatic, developer-friendly option right now. It can evolve with us and > potentially complement more formal docs in the future. > > Best, > -=e > > > On Wed, Apr 2, 2025 at 7:09 AM Dianjin Wang <wangdian...@gmail.com> wrote: > > > Hi all, > > > > I'd like to start a discussion on whether we should create a Wiki for > > Cloudberry. > > > > Currently, we have some scattered or informal knowledge, such as > > feature design documents, marketing events, proposals, and more, that > > need a flexible place for organization. Managing these directly on the > > website can be cumbersome, so I prefer having a Wiki space would be > > beneficial. > > > > There are two possible options: > > 1. GitHub Wiki – Using the Wiki feature of the Cloudberry main GitHub > > repo, which can be enabled in the `.asf.yaml` file. > > 2. ASF Confluence – Leveraging Apache's Confluence instance for > > documentation. > > > > Do you think we should set up a Wiki? If so, which option do you > > prefer, or do you have other suggestions? > > > > Love to hear your thoughts on this. > > > > Best, > > Dianjin Wang > > > > --------------------------------------------------------------------- > > To unsubscribe, e-mail: dev-unsubscr...@cloudberry.apache.org > > For additional commands, e-mail: dev-h...@cloudberry.apache.org > > > > > > -- > Ed Espino > Apache Cloudberry (incubating) & MADlib > -- Best, Dianjin Wang
