function search_api_federated_solr_help in Search API Federated Solr 8

Same name and namespace in other branches

1. 8.3 search_api_federated_solr.module \search_api_federated_solr_help()
2. 8.2 search_api_federated_solr.module \search_api_federated_solr_help()
3. 7.3 search_api_federated_solr.module \search_api_federated_solr_help()
4. 7 search_api_federated_solr.module \search_api_federated_solr_help()
5. 7.2 search_api_federated_solr.module \search_api_federated_solr_help()
6. 4.x search_api_federated_solr.module \search_api_federated_solr_help()

Implements hook_help().

File

./search_api_federated_solr.module, line 15

Contains hook implementations for the Federated Solr Search API Module.

Code

function search_api_federated_solr_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {

    // Main module help for the search_api_federated_solr module.
    case 'help.page.search_api_federated_solr':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('This module facilitates indexing data from multiple Drupal sites into a single Solr search index. It also provides a ReactJS front end to render search results from that Solr search index.') . '</p>';
      $output .= '<h3>' . t('Usage') . '</h3>';
      $output .= '<p>' . t('On each site included in the federated search, you will need to:') . '</p>';
      $output .= '<ol>';
      $output .= '<li>' . t('Install this module') . '</li>';
      $output .= '<li>' . t('Configure a Search API server to connect to the shared Solr index') . '</li>';
      $output .= '<li>' . t('Configure a Search API index according to the <a href="@recommended_schema">recommended schema</a>', [
        '@recommended_schema' => 'https://github.com/palantirnet/search_api_federated_solr/blob/master/docs/federated_schema.md',
      ]) . '</li>';
      $output .= '</ol>';
      $output .= '<p>' . t('In order to display results from the Solr index:') . '</p>';
      $output .= '<ol>';
      $output .= '<li>' . t('Configure the application route and settings at <code>@settings</code>', [
        '@settings' => '/admin/config/search-api-federated-solr/search-app/settings',
      ]) . '</li>';
      $output .= '<li>' . t('Set permissions for <code>Use Federated Search</code> and <code>Administer Federated Search</code> for the proper roles.') . '</li>';
      $output .= '<li>' . t('Optional: <a href="@theme">Theme the ReactJS search app</a>', [
        '@theme' => 'https://github.com/palantirnet/search_api_federated_solr/blob/master/docs/theme.md',
      ]) . '</li>';
      $output .= '<li>' . t('Optional: Add the federated search page form block to your site theme') . '</li>';
      $output .= '</ol>';
      $output .= '<h3>' . t('Updating the bundled React application') . '</h3>';
      $output .= '<p>' . t('When changes to <a href="@react">federated-search-react</a> are made they\'ll need to be pulled into this module. To do so:', [
        '@react' => 'https://github.com/palantirnet/federated-search-react/',
      ]) . '</p>';
      $output .= '<ul>';
      $output .= '<li>' . t('Update <code>package.json</code> with the new version.') . '</li>';
      $output .= '<li>' . t('Run <code>yarn install</code>') . '</li>';
      $output .= '<li>' . t('Delete the old versions of <code>js/main.*.js (and .map)</code> and <code>css/main.*.css (and .map)</code>') . '</li>';
      $output .= '<li>' . t('Update <code>search_api_federated_solr.libraries.yml</code> to reference the new file.') . '</li>';
      $output .= '</ul>';
      $output .= '<h3>' . t('More information') . '</h3>';
      $output .= '<ul>';
      $output .= '<li>' . t('<a href="@usage">How to use this module</a>', [
        '@usage' => 'https://github.com/palantirnet/search_api_federated_solr/blob/master/docs/usage.md',
      ]) . '</li>';
      $output .= '<li>' . t('<a href="@federated_schema">How to configure a Search API Index for federated search</a>', [
        '@federated_schema' => 'https://github.com/palantirnet/search_api_federated_solr/blob/master/docs/federated_schema.md',
      ]) . '</li>';
      $output .= '<li>' . t('<a href="@theme">How to theme the ReactJS search app</a>', [
        '@theme' => 'https://github.com/palantirnet/search_api_federated_solr/blob/master/docs/theme.md',
      ]) . '</li>';
      $output .= '<li>' . t('<a href="@block">How to add the search form block</a>', [
        '@block' => 'https://github.com/palantirnet/search_api_federated_solr/blob/master/docs/block.md',
      ]) . '</li>';
      $output .= '</ul>';
      return $output;
    default:
  }
}