@jenkins-infra/copy-editors , @rtyler
One of the blockers to getting more and better documentation added to jenkins.io has been the lack of an overarching structure into which documentation can fit. This PR attempts to remedy that. It provides the basic structure for a "Jenkins Handbook" into which we can put documentation.
There are a set of chapter folders with section files inside. The chapter and section order are controlled by chapter.yml files. The chapters each differ in structure depending on the intended audience and the area/topics covered. Each index.adoc describes the area, audience, and (planned) structure/style for that chapter.
Suggested scope for this PR: (please provide feedback):
- Structure and intent - Each index.adoc describes the what will be covered in each chapter. If you disagree with what is described, speak up. If you think we have a some chapter and think it should be removed, definitely want to hear that.
- index.adoc copy-editing - yes, please.
- Large gaps - if you think there is an important area or group of topics that do not fit into one of the existing chapters, call it out. Basically, if you consider the existing chapters and say, "Those are all good but we need to document <topic/area> and it just won't fit under any of those headings", say so. Adding new chapters is not hard but it would be worth discussing now.
(Suggested) Out of scope for this PR (feedback welcome, but I'd prefer not to block this PR for it):
- Missing sections or other content aside from index.adoc - this is just the basic structure. Content comes next.
- Chapter order: chapters ordered based on value in chapter.yml files. It is easy to reorder them later.
- Section order - sections in each chapter are ordered based on the list in chapter.yml. It is easy to reorder them.
Thanks for your help!