Actions
Wiki IA Overhaul¶
Summary¶
This blueprint is designed to capture requirements and structure for an overhaul of the Ceph wiki.
Owners¶
- Patrick McGarry (Red Hat)
- Name (Affiliation)
- Name
Interested Parties¶
- Eric Mourgaya Virapatrin (Credit Mutuel Arkea)
- Name (Affiliation)
- Name
Current Status¶
Right now the Ceph Wiki has been utilized primarily as a container for Ceph Developer Summit (CDS) documentation. There are a few other various pieces of info that have been added on an ad hoc basis. We would like to start a major push to clean the structure and populate the wiki with the various information floating around the Ceph community.
Detailed Description¶
Below is a list of new proposed sections to be added to the wiki:
- speakers by region/topic
- This would be a list of anyone willing to speak about Ceph
- Could be broken down by region so that we can easily see speakers for Ceph days and other conferences
- event calendar for community (in addition to meetups)
- This would be a canonical resource for all Ceph-related events in meatspace
- Conferences, Ceph Days, meetups, etc
- ceph tools / community contribs
- A listing of all community-contributed plugins, tools, products, etc
- procedures
- This would be a guide section for all procedural writeups on Ceph
- This would include development procedures (eg: how to commit) as well as others (eg: how to tune)
- hardware compatibility guide (for community/partner editing)
- The goal here was to put a hardware guide in a community-editable space
- Any third party should be able to contribute their reference architecture or other documentation
- community swag? (t-shirts, etc)
- A note on how local meetups can get swag
- Part of this would come from the existing user committee page
- could be scaled to other swag in the long term
- "Why we contribute" for corporate participants
- A good place for any contributing organizations to lay out their goals and aspirations as a Ceph participant
- Academic outreach / Ceph in academia
- Ultimately the Ceph community would love to be more involved in the education of students
- This could contain GSoC, hackathons, and other programs
- Orchestration & Deployment (update Juju writeup, docker, etc)
- This would be a devops-centric series of guides
- This might have too much overlap to be it's own entity, so could just be aggregation/cross-linking
- Committer listing for each release
- This is already being done via the Ceph user committee
- Would be good to have historic listing
- Roadmap page for each module (esp CephFS)
- Each "Component Technical Lead" will be responsible for documenting pending work for their module
- Chum bucket / paper cuts / etc
- Several places to distribute coding tasks
- Chum bucket: small contained new feature development
- Paper Cuts: self-contained bugs
- Sideboard: previous blueprints that were abandoned
- High value documentation (things to read first)
- A documentation resource that aggregates the most important doc to read in order to come up to speed quickly
- This can pull from /master/doc, blogs, whitepapers, etc and should evolve over time
Work items¶
Coding tasks¶
- Integrate parts of documentation workflow (gitbuilder) to push to wiki [maybe]
- Build FAQ/Guide structure (Mindtouch)
- Task 3
Build / release tasks¶
- Task 1
- Task 2
- Task 3
Documentation tasks¶
- Create structure w/ placeholder pages
- Populate content
- Populate Guides/FAQs
Deprecation tasks¶
- Task 1
- Task 2
- Task 3
Proposed Structure:
- Community
- Meetups
- Press
- Ceph Technical Committee (CTLs)
- Ceph User Committee (new)
- Meetings
- Swag (new)
- Committer List (new)
- Speakers (new)
- Event Calendar (new)
- Ceph in Academia (new)
- GSoC (new)
- Development
- Ceph Tools (new)
- Tasks (new)
- Sideboard
- Chum Bucket
- Paper Cuts (new)
- Misc
- FAQs
- FAQ
- High Value Doc (new)
- Guides
- General Guides
- Getting Started
- Orchestration and Deployment (new)
- Procedures (new)
- Hardware Compatibility (new)
- Planning
- Blueprints
- Dumpling
- Emperor
- Firefly
- Giant
- Submissions
- Roadmap
- RADOS/Core (new)
- CephFS (new)
- RBD (new)
- RGW (new)
- Calamari (new)
- Ceph Developer Summit
- CDS Dumpling
- CDS Emperor
- CDS Firefly
- CDS Giant
- Blueprints
Updated by Jessica Mack almost 9 years ago · 1 revisions