Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructing: Fix the part/chapter structure of the books #8494

Closed
dedemorton opened this issue Sep 28, 2018 · 1 comment
Closed

Restructing: Fix the part/chapter structure of the books #8494

dedemorton opened this issue Sep 28, 2018 · 1 comment

Comments

@dedemorton
Copy link
Contributor

Right now, the Beats books are not ideally structured because the structure has grown organically over time. To save time and minimize the amount of rework required, we've compromised and modified the existing structure to meet our needs. This has resulted in a rather strange book structure that begins as single chapters and morphs into sections halfway through the book. The parts are necessary (given the current heading levels and chunk setting) to achieve the levels of nesting required, but they make maintaining the book over time (and reusing content) more challenging.

Ideally, we should strive for a simple structure where there is a one to one mapping between each source file and the topic that gets built from it. We should use a simple topic hierarchy and leverage the chunk setting to create the topic hierarchy we require.

This is a significant effort and will result in massive diffs. This effort is best left for a time when we are updating to a new format (such as ascidoctor if we go that direction) or making a significant change to the information architecture of our books (for example, if we go to one Beats book rather than several).

@dedemorton
Copy link
Contributor Author

Closing this issue because we will make the minimal changes required to get the book building in asciidoctor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant