[TASK] Clean-Up the docs by deleting not available stuff

Removes: * sys_domain / domain record accurences * Legacy Site mode stuff * TypoScript `plugin.tx_solr.solr` stuff * not included images
TYPO3-Solr · Oct 9, 2023 · 21e06a7 · 21e06a7
1 parent 5043cdd
commit 21e06a7
Show file tree

Hide file tree

Showing 14 changed files with 5 additions and 189 deletions.
diff --git a/Classes/IndexQueue/PageIndexer.php b/Classes/IndexQueue/PageIndexer.php
@@ -229,8 +229,7 @@ protected function getPageIndexerRequest(): PageIndexerRequest
     /**
      * Determines a page ID's URL.
      *
-     * Tries to find a domain record to use to build a URL for a given page ID
-     * and then actually build and return the page URL.
+     * Builds a URL for a given page ID and then actually build and return the page URL.
      *
      * @throws DBALException
      * @throws \Exception

diff --git a/Configuration/TypoScript/BootstrapCss/setup.txt b/Configuration/TypoScript/BootstrapCss/setup.txt
diff --git a/Documentation/Backend/ConnectionManager.rst b/Documentation/Backend/ConnectionManager.rst
@@ -78,29 +78,3 @@ The example above shows that you are able to define the setting
 ``solr_host_read`` on the language level. Since this is a more advanced
 configuration and the user interface should be kept simple, this can only be
 configured in the yaml.
-
-Legacy Mode
------------
-
-.. warning::
-
-   The ability to use this mode will be removed in EXT:solr 11.0.
-
-In EXT:solr all the configuration, including options affecting backend functions, are done in TypoScript. The clear cache menu provides an entry to initialize the Solr connections configured in TypoScript.
-
-
-* Configure the Solr connection in TypoScript under plugin.tx_solr.solr, providing host, port, and path.
-* On your site's root page set the flag Use as Root Page on the Behaviour tab.
-* Initialize the Solr connections through the clear cache menu
-
-.. figure:: /Images/GettingStarted/typo3-initialize-connections.png
-
-    Initialize all Solr connections
-
-When initializing the Solr connections the extensions looks for all the pages with the root flag set, generates the TypoScript configuration for that page like in the frontend and reads the Solr connection parameters.
-
-The extension also repeats that process for each language configured on the installation's root (uid = 0). This way you can configure different Solr cores for each language by using regular conditions that change the path of the Solr connection depending on the currently selected language.
-
-Once all the configured Solr connections in the installation are found, they're stored in TYPO3's registry so that they can easily be retrieved without needing to reevaluate the TypoScript configuration every time we connect to Solr.
-
-All that magic happens in class source:Classes/ConnectionManager.php. The connection manager and it's public API actually must be used whenever a Solr connection is needed.
diff --git a/Documentation/Backend/IndexQueue.rst b/Documentation/Backend/IndexQueue.rst
@@ -106,8 +106,8 @@ The TypoScript constant "plugin.tx_news.settings.detailPid" is used to configure
 Sysfolders outside the siteroot
 -------------------------------
 
-The page with a domain record act as a siteroot in EXT:solr. It is a good practice not to nest the siteroots and do the configuration on the root page.
-Changes on records that are done in the TYPO3 backend are detected and the Solr document will be readded to the index queue when something was changed.
+It is a good practice not to nest the siteroots and do the configuration on the root page.
+Changes on records that are done in the TYPO3 backend are detected and the Solr document will be re-added to the index queue when something was changed.
 
 By default only records are monitored for a site that are in the tree of the site. If you want to index records and detect changes on records in a different siteroot, the
 index queue configuration needs to contains "additionalPageIds" (e.g.: 'plugin.tx_solr.index.queue.<queueName>.additionalPageIds = 45,48').

diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
@@ -27,7 +27,6 @@ Configuration Reference
 	./Reference/TxSolr
 	./Reference/TxSolrGeneral
 	./Reference/TxSolrView
-	./Reference/TxSolrSolr
 	./Reference/TxSolrIndex
 	./Reference/TxSolrSearch
 	./Reference/TxSolrSuggest

diff --git a/Documentation/Configuration/Reference/ExtensionSettings.rst b/Documentation/Configuration/Reference/ExtensionSettings.rst
@@ -38,16 +38,6 @@ allowSelfSignedCertificates
 
 Can be used to allow self signed certificates - when using the SSL protocol.
 
-
-allowLegacySiteMode
--------------------
-
-:Type: Boolean
-:Since: 10.0
-:Default: 0
-
-Can be used to allow using classic TypoScript Configuration for Sites.
-
 monitoringType
 --------------
 

diff --git a/Documentation/Configuration/Reference/TxSolrSolr.rst b/Documentation/Configuration/Reference/TxSolrSolr.rst
diff --git a/Documentation/FAQ/Index.rst b/Documentation/FAQ/Index.rst
@@ -451,7 +451,6 @@ The following example shows, how you can configure a custom switchable entry tem
 When you deploy a system automatically and you use EXT:solr there are some things that might be complicated:
 
 * You want to use a different Solr endpoint for each environment
-* EXT:solr depends on an existing domain record
 
 To avoid that, you can set or generate these settings in the TYPO3 AdditionalConfigruation.php file and use them in your system.
 

diff --git a/Documentation/GettingStarted/ConfigureExtension.rst b/Documentation/GettingStarted/ConfigureExtension.rst
@@ -69,7 +69,7 @@ This Module can be used to setup and configure the Apache Solr connections.
 
 .. warning::
 
-   EXT:Solr needs a proper domain as base for the site. If the base is set to "/" or a similar relative path, the Indexing will throw an error, so please make sure that "base" is a fully qualified domain like "https://my.project.tld/"
+   EXT:Solr needs a proper domain/host as base for the site. If the base is set to "/" or a similar relative path, the Indexing will throw an error, so please make sure that "base" is a fully qualified domain like "https://my.project.tld/"
 
 
 Configure Solr Connections

diff --git a/Documentation/Images/GettingStarted/typo3-domain-record.png b/Documentation/Images/GettingStarted/typo3-domain-record.png
diff --git a/Documentation/Images/GettingStarted/typo3-initialize-connections.png b/Documentation/Images/GettingStarted/typo3-initialize-connections.png
diff --git a/Resources/Private/Partials/Backend/NoSiteAvailable.html b/Resources/Private/Partials/Backend/NoSiteAvailable.html
@@ -17,18 +17,6 @@
 				<li>Configure EXT:solr with the TYPO3 site module.</li>
 				<li>Check the reports module if any solr error is shown.</li>
 			</ul>
-
-			<hr />
-			<p><strong>OR</strong></p>
-			<hr />
-			<p>If you want to use solr with the legacy configuration (domain record and typoscript of EXTCONF setup):</p>
-			<ul>
-				<li>Your site has a domain configured, please create a domain record on the root page, or configure it in "TYPO3_CONF_VARS|EXTCONF|solr|sites|###rootPageId###|domains"</li>
-				<li>Your site has a page, marked as root page.</li>
-				<li>Your page has included the solr typoscript configuration.</li>
-				<li>You've initialized the solr connections in the backend with the menu item "Initialize solr connections"</li>
-				<li>Afterwards please check if the reports module is showing any errors.</li>
-			</ul>
 		</f:be.infobox>
 	</f:else>
 </f:if>
diff --git a/Resources/Private/Templates/Backend/Reports/SolrConfigurationStatusDomainRecord.html b/Resources/Private/Templates/Backend/Reports/SolrConfigurationStatusDomainRecord.html
diff --git a/Tests/Integration/Domain/Site/SiteRepositoryTest.php b/Tests/Integration/Domain/Site/SiteRepositoryTest.php
@@ -106,6 +106,6 @@ public function canGetSiteWithDomainFromSiteConfiguration()
         $this->importCSVDataSet(__DIR__ . '/Fixtures/can_get_site_by_page_id.csv');
         $site = $this->siteRepository->getSiteByPageId(1);
         $domain = $site->getDomain();
-        self::assertSame('testone.site', $domain, 'Can not configured domain with sys_domain record');
+        self::assertSame('testone.site', $domain, 'Can not get the domain from Site-Config.');
     }
 }