project-codeflare / project-codeflare/codeflare-sdk
project codeflare open source status
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 35
- Forks
- 66
- Avg merge
- 48m
- Merged PRs (30d)
- 7
Description
I am opening a tracking issue to address the open source status of the codeflare project. The following enhancements should be considered.
A landing page website with information about CloudFlare and its subprojects
We do have the https://codeflare.dev/ website but its missing information on the various subprojects. Also it has the IBM Research logo at the top left - we might want to remove it to make this more vendor neutral.
Organized, public user docs
All the "Learn More" docs at the bottom of https://codeflare.dev/ take you to IBM Research blogs about codeflare. I think those are fine as that's where the project originated. We should augment it with links to more user facing docs on using the sdk. Also the "Learn More" section may need to be reorganized a bit.
Information on "how to get involved"
Very basic how to contribute guides (likely, one per subproject)
Doing some outreach activity -- talks, videos, blogs, etc. -- promoting the project technology
The landing page website (which we already have) doesn't need to be that sophisticated. What it needs, at a minimum, is:
- project name & logo
- overall purpose/description of the project
- contact info, esp. including slack, email, any public meetings
- list of subprojects with links to "main" repo of each
- links to docs, videos (if any)
- code of conduct
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the current landing page at codeflare.dev and its existing “Learn More” links to IBM Research blogs. Break the request into separately scoped work for project information, subproject links, user documentation, contribution guides, contact details, and the code of conduct. Done means the site covers the minimum landing-page information and provides organized, public paths for users and contributors.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, documentation, web-dev
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100