[
https://issues.apache.org/jira/browse/SOLR-12930?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16666199#comment-16666199
]
Shawn Heisey commented on SOLR-12930:
-------------------------------------
bq. The idea of a single file was about taking all those smaller files we write
and publishing them as a single HTML page that is the thing make public
If the overall guide's size and organizational strategy will generate a useful
document as a single published page, whether it's multiple source files or a
single file, then I'm all for it. I suspect that as the dev guide evolves and
grows, eventually it will work better as a handful of pages ... but I could be
completely wrong about that. Your point about the need for navigation when
there are multiple pages is spot on.
bq. The basic infrastructure I created in my small example project
Slightly ashamed to admit that I haven't actually looked at it. A bit
overwhelmed with real-world happenings, so I am skimming things that I should
probably be studying in-depth.
bq. There's a little bit of complexity there in terms of changing our usual
workflows, but maybe that's worth it
Which if I'm not mistaken is the gist of the effort that
[[email protected]] is trying to spearhead. I think everyone is more or
less on the same page. I am encouraged when discussions reveal a rough
consensus for a reasonably clear path forward.
bq. The Gitbox transition is interesting in this context.
Digesting that and trying to think ahead to possible gotchas and benefits
(challenging when my knowledge is incomplete), I had a slight worry that the
"issues" section of github would become a distraction. I found that the
apache/lucene-solr mirror currently on github doesn't have that feature turned
on, so the link isn't even there. I have in mind a small change to README.md
for clarification purposes on issue tracking -- noting that the omission of
"issues" in github is intentional because we use Apache Jira for that. If I
can find a moment to whip up a patch, I'll attach it here. One thing I wonder
is whether we can have github show the "issues" link, but instead of having the
feature actually activated, have the link go to a page (markdown?) about Jira.
> Add great developer documentation for writing tests.
> ----------------------------------------------------
>
> Key: SOLR-12930
> URL: https://issues.apache.org/jira/browse/SOLR-12930
> Project: Solr
> Issue Type: Sub-task
> Security Level: Public(Default Security Level. Issues are Public)
> Components: Tests
> Reporter: Mark Miller
> Priority: Major
> Attachments: solr-dev-docs.zip
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
