Versions Compared

Old Version 4

changes.mady.by.user Cassandra Targett

Saved on

compared with

New Version 5

changes.mady.by.user Cassandra Targett

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

There are now 5 main top-level categories (screenshot below):

  • Getting Started
  • Deployment Guide
  • Configuration Guide
  • Schema and Indexing Guide
  • Query Guide

...

The massive Solr Tutorial has been split into 4 pages - an intro and then one for each exercise - and there is a new dedicated section under "Getting Started" for Tutorial content. The AWS Tutorial and the "Getting Started with SolrCloud" page have been moved here (the latter being renamed to "SolrCloud Tutorial"). Screenshots below showing subsection list.

I did not try to improve any of the tutorial content, so if possible let's not discuss now about whether the exercises are appropriate or easy or whatever problems you have with them. It's not really relevant to this overall exercise IMO.

...

  • New section layouts in "parent" pages (the ones that are mostly "here is what's in this section"). Where there are subsections of subsections the subsection list lives only on one page - the lowest level - and is tagged so it can be automatically included in all parent pages. This allows us to have descriptions consistent but maintained in only one place.
    • For example, the "Query Guide" has a subsection "Query Syntax and Parsing" which has several child pages. The "TOC" (as it were) is maintained on "Query Syntax and Parsing" and pulled into "Query Guide" only at build time.
    • This is also now in a table, and I've defined specific formatting for this purpose to display it in two columns instead of our previous long lists.
    • Multiple child page subsections have h3-level headers to differentiate them.
    • A couple of examples in screenshots below.
  • All sentences start on new lines. I've missed some; IMO it's not a critical component, but can be continued ongoing.
  • New format for parameters (only very partially done). See screenshots below.
  • The icons in the left navbar are changed from arrows to + and - symbols.
  • External links all now really open in new tabs (as has long been indicated by the icon that follows the URLs) (uses JS).
  • Guide home page (index.adoc) redesigned a bit to take up less real estate (screenshot below). Download button has moved to top navbar as a link.
  • Simplified the link text in top navbar "Resources" section; added "Contribute" to link to ref guide contribute docs in solr/dev-docs (TBD with SOLR-15458).

...