Closed (fixed)
Project:
Search API
Version:
8.x-1.x-dev
Component:
Documentation
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
14 Apr 2015 at 13:51 UTC
Updated:
26 Nov 2016 at 13:34 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
nick_vhComment #2
nick_vhComment #3
drunken monkeyWe should definitely not change a completely unrelated module's configuration on our own, so the second option is out of the question.
Displaying a warning might make sense, yes – it might just be annoying to people who know what they're doing and still want that. But as long as it's just a warning, not an error, I guess it would be acceptable. (If it annoys too many, we could add a state to say "yes, I'm sure, I want both".
Comment #4
nick_vhNext steps here are to create that warning. Tagging as novice as this is a great entry level issue.
Comment #5
nick_vhMost likely this warning should appear during install and when looking at the extensions page. I guess in Drupal 7 this was named hook_requirements but perhaps there are better places to do this?
Comment #6
marcvangendOK, I'm starting to work on this.
Comment #7
drunken monkey@ marcvangend: Great! In this case, please set the "Assigned" field to yourself.
Comment #8
marcvangendThis patch adds a warning:
1) During installation of the Search API module
2) On the Status Report page
See screenshots.
Comment #9
nick_vhWe need to link to documentation why this is important. Are you able to find a handbook page that explains this? If that doesn't exist, we should create it.
Comment #10
nick_vhComment #11
drunken monkeyThanks for providing the patch!
This is not the correct way to include a link in translated text, since this changes the base string if the path changes, and also doesn't use the correct Drupal way to create the link (breaking, e.g., when Drupal is installed in a sub-directory).
I now corrected the line to:
Other than that, the patch looks fine, thanks again!
Committed.
Comment #13
drunken monkeyAh, sorry, Nick, committed before seeing your comment. Makes sense, though, setting back to "Active" – we should add that information in the handbook and then link to it in the message.
Comment #14
drunken monkeyComment #15
andypostJust a bit of clean-up and replaced deprecated
Which page exactly?
Comment #18
andypostproper one
Comment #21
drunken monkeyMaybe just as another question in the FAQs? Or as a new child page of the "Getting started" section.
Comment #22
ikit-claw commentedDo you still need a hand with this or is it sorted now?
Comment #23
drunken monkeyThe patch seems to need a re-roll and we'd still need someone to add this to the documentation, if you're up for it.
Comment #24
gaydabura commentedComment #25
gaydabura commentedComment #26
andypostif this is a only usage of the function better move the check with inline code
Comment #27
gaydabura commented@andypost
it is used twice
in search_api_install() and in search_api_requirements()
Comment #28
andypostFiled follow-up #2670666: Get rid of search_api_install() message
I'd better removed this hook install and added hook_help() mention about that after configuring module you can disable core search in favor of the module
RTBC+1
Comment #29
gaydabura commentedupdated patch
Comment #30
andypostgreat! but please put //comment inside if() with message
Comment #31
gaydabura commentedthnx @andypost , patch updated
Comment #32
andypostgreat, let's get maintainer's opinion
Comment #33
drunken monkeySee #2670666-7: Get rid of search_api_install() message: if we want to keep the other issue, I would say this is completely off-topic for this one. Here, we should add documentation on the reasons for disabling Core Search to the handbook, and then add a link to that to the help message (and a link to the "Uninstall" page, of course).
We can also do all that just in this issue, since it's more or less just a follow-up to what was committed. But then there would be no point in having the other issue. Or, last option, mark this issue as fixed and change the other issue to a general follow-up issue.
Now, it's completely unclear what either of them should implement.
Comment #34
andypostI'd better refocus this issue to update help page and other one to clean-up useless
hook_install()Comment #35
andypostLooks that's exactly the same as was commited in #2670666: Get rid of search_api_install() message
Comment #36
drunken monkeyYeah, so here we just have to add the documentation to the handbook and link to that.
Comment #37
drunken monkeyComment #38
sinn commentedInformation about Search API and Drupal Search modules has been added to Getting started chapter in handbook. Link to this page has been added to message.
Comment #39
borisson_Link looks good.
Comment #40
borisson_Actually - that link goes to a drupal 7 page of documentation, is there a better place we can link to? The issue is on the page there - but I think this is a good reason to start / improve drupal 8 docs.
Back to NW for that.
Comment #41
sinn commentedChecked Drupal 7 Search module - there is the same problem too. So this information is valid for Drupal 7 and 8 both.
Comment #42
borisson_In that case, we can keep the link as-is.
Comment #43
drunken monkeyI don't think "Getting started" is the best place for this, and the information was also a bit sparse.
Moved and expanded the documentation in the handbook and updated the patch.
Comment #44
borisson_Comment #46
drunken monkeyThanks for reviewing! Committed.
Thanks again, everyone!