[SOLR-10655] refactor duplicate ref guide content into "snippet" files that can be included

• Type: Sub-task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 9.0
• Component/s: documentation
• Assignee: Unassigned
• Reporter: Chris M. Hostetter
• Created: 09/May/17 23:17
• Updated: 12/May/22 00:26
• Resolved: 11/Aug/21 18:59

Description

in cwiki, we were using the "excerpt" and "excerpt-include" macros to mirror some content across multiple pages.

as part of the cwiki->adoc migration, these macros were just evaluated durring export, and the content is now duplicated.

moving forward, we should refactor this duplicated content into "snippet" files that can be included in multiple places. A few things we need to be careful about when doing this:

• ensuring anchors and relative links are generated in such a way that they are still unique per-section
• that some convention / page attributes are used such that the BuildNavAndPDFBody code doesn't try to include them as "real" pages (or errors that they have no parent)

Issue Links

• is fixed by: SOLR-14444 Ref Guide Redesign Phase 2: Page Organization Overhaul
• is related to: SOLR-10296 Convert existing Ref Guide and post-conversion cleanup