[
https://issues.apache.org/jira/browse/SOLR-10655?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17196164#comment-17196164
]
Cassandra Targett commented on SOLR-10655:
------------------------------------------
bq. this ticket could be worked now
Sure, it could have been worked on at pretty much any point in the past 3 years
after the initial push to move the Ref Guide into the source repo. But that
statement sort of underestimates the various decisions, build changes, and
content re-organization that would need to go into really realizing the overall
vision this issue encapsulated. The TODO was left in those files because we
wanted to be sure to document points of departure from what existed in the old
Confluence Ref Guide during that conversion - it probably could be removed at
this point. Or, since it's hurting no one and nothing, we could just leave it.
> refactor duplicate ref guide content into "snippet" files that can be included
> ------------------------------------------------------------------------------
>
> Key: SOLR-10655
> URL: https://issues.apache.org/jira/browse/SOLR-10655
> Project: Solr
> Issue Type: Sub-task
> Components: documentation
> Reporter: Chris M. Hostetter
> Priority: Major
>
> 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)
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
