apache / apache/camel-website

Cleanup and reorganize the contribution documentation

Open
#1,017 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
CSS
Stars
76
Forks
202
Avg merge
1d 12h
Merged PRs (30d)
19

Description

Once we merge apache/camel#10476, which will change the way we build, we should adjust the contribution documentation to reflect that.

My suggestion is to do the following:
- Remove the Camel Core specific contribution details from the [main website](https://github.com/apache/camel-website/blob/aa94dec2af6ece1e963fbb116598a8f3a9be1f71/content/community/contributing.md) and add it to the Core contributing guide
- Describe that each sub-project may have slightly different contribution guidelines (due to the specific nature of each of them)
- Create a contributing guide if missing and/or add a link to it from the main website.

Contributor guide

No contributing guide indexed for this repository

Research direction

Check the status of apache/camel#10476 first, then read content/community/contributing.md in the main website. Compare its Camel Core-specific details with the Core contributing guide and check which sub-projects lack guides or links. Done means the main guide reflects the new build approach, points to sub-project guidance, and no longer contains Core-specific details.

Written by the indexing model from the issue text.

Assessment

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.