apache / apache/cloudberry-site

New Page: Project and Engineering Guides

Open
#211 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
26
Forks
42
Avg merge
3d 13h
Merged PRs (30d)
7

Description

> > @tuhaihe Are you planning on adding a project based information (including links) for Cloudberry's Matomo analytics page somewhere? I think it should be readily accessible by the dev community. Any details on it's setup, configuration and administration (or pointers to information with this) might also be helpful.
> > I have been thinking of this from the developer and release perspective. With Apache MADlib we used the Apache Wiki. As a project we have the option of enabling the GitHub wiki feature for such dynamic information. I have a need to capture project release engineering based information and I would prefer an easy and collaborative space and thus I am leaning toward the GitHub wiki. What do you think?
>
> Good idea. We can also create a new page module named `Developer Guide` on the website to help community developers learn about the development aspects of the kernel, releases, website, and other areas, which will be easier to maintain and search for by developers and search engines like Google.
>
> Does it make sense to you? I would like to create one new PR for this.

Cool ... Maybe we can create a basic top-level page "Project and Engineering Guides" with sub-pages. Here is a basic break down we use to help us think through this.

Infrastructure
- Website
- Metrics
- Bots
- DockerHub

Social Media
- Accounts

Release Engineering
- Release numbering scheme
- Release cadence
- Release process

Development guides
- basic development
- test execution
- Deep dives
- kernel
- query optimizers
- components
- GitHub CI use

_Originally posted by @edespino in https://github.com/apache/cloudberry-site/issues/205#issuecomment-2545107201_

Contributor guide

No contributing guide indexed for this repository

Research direction

No file or test is named. Start by reviewing the existing website page structure and how top-level pages and sub-pages are represented, then map the proposed infrastructure, social media, release engineering, and development guide sections into that structure. Done means the new Project and Engineering Guides page and its sub-pages are published, organized, and easy for developers to find.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.