Hi,

For the Solr MCP project we have a draft for the sub-project web site at 
https://github.com/apache/solr-site/pull/160
Also an effort has been started to add in-repo product documentation in the 
solr-mcp repo, see https://github.com/apache/solr-mcp/pull/143

I started reviewing some of this but it raises some questions that I wanted to 
bring back here on the dev-list, and it is about how we separate project docs 
on the web site and product docs elsewhere.

I assume we want to have a project landing page describing the project briefly 
as we have for the Operator, and that the website links to product reference 
documentation.

Should the MCP product (ref) docs be versioned or are we happy with only 
publish for the latest version online?

Where should MCP product (ref) docs be publiished? I see a few options:

A. Standalone GH pages site, like solr operator has been doing so far and that 
Solr-Orbit does
B. GH site like A but wired into solr.apache.org/mcp/docs 
<http://solr.apache.org/mcp/docs> so that it looks like its is hosted on the 
main site (but with different styling)
C. Include as a new Antora module in the main Solr ref guide, but docs still 
live in solr-mcp repo (This is what Houston is doing with Operator docs now and 
as Eric proposes in #11 <https://github.com/apache/solr-mcp/issues/11>)
D. Copied into main solr-site as sub pages during Pelican build time (as #143 
proposes)

I think there is not one "correct" way here, but perhaps we want as a project 
to have some unified approach. E.g. what content fits naturally into the ref 
guide and what does not?

As of now I'd go for a tiny project-only oriented content on solr-site, with 
links to option B for the product docs. But I'm also easening up to the thought 
of MCP being just a different access mode for solr and thus fit into the main 
ref guide as an Antora module.

Jan

Reply via email to