About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
administration:vufind_for_project_managers

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
administration:vufind_for_project_managers [2015/12/21 16:49] – ↷ Links adapted because of a move operation demiankatzadministration:vufind_for_project_managers [2022/10/13 14:25] (current) – [Customizing for your library] demiankatz
Line 1: Line 1:
-====== VuFind for Project Managers ======+====== VuFind® for Project Managers ======
  
- +It took my technical folks just a few hours to successfully install VuFind®.  Now what should you, the project manager, do?  This page is designed to help project managers form their initial "to-do" roadmap/list.  Some project managers will have more tech. background, some less.  I'm going for a middle-of-the-pack approach, but please feel free to edit / add your items!
-It took my technical folks just a few hours to successfully install VuFind.  Now what should you, the project manager, do?  This page is designed to help project managers form their initial "to-do" roadmap/list.  Some project managers will have more tech. background, some less.  I'm going for a middle-of-the-pack approach, but please feel free to edit / add your items!+
  
 ===== Install patches ===== ===== Install patches =====
  
-  * If the VuFind release you installed has been around for a while, it is possible that there are known issues with it.  Take a look at the [[http://www.vufind.org/jira|JIRA]] issue manager and [[https://github.com/vufind-org/vufind/pulls|GitHub pull requests]] to get a feel for known issues and current work in progress.  Perhaps your development team can fix some problems and contribute code back to the community.+  * If the VuFind® release you installed has been around for a while, it is possible that there are known issues with it.  Take a look at the [[http://www.vufind.org/jira|JIRA]] issue manager and [[https://github.com/vufind-org/vufind/pulls|GitHub pull requests]] to get a feel for known issues and current work in progress.  Perhaps your development team can fix some problems and contribute code back to the community.
  
 ===== Establish tracking practices for you and/or your team ===== ===== Establish tracking practices for you and/or your team =====
  
-  * Keep track of your changes.  This will become very important if you have to upgrade to a new version of VuFind in the future.  If you are making a small number of changes, you could do something as simple as creating a Google Doc Spreadsheet to track directory, filename, date, changes made to file on that date, and a change reason.  If you plan on making many complex changes, you should probably invest some time in learning about a change management package like [[development:recommended_tools:git|Git]]. Also be sure to review the best practices on the [[development:architecture:customizing_vufind|Customizing VuFind]] page.+  * Keep track of your changes.  This will become very important if you have to upgrade to a new version of VuFind® in the future.  If you are making a small number of changes, you could do something as simple as creating a Google Doc Spreadsheet to track directory, filename, date, changes made to file on that date, and a change reason.  If you plan on making many complex changes, you should probably invest some time in learning about a change management package like [[development:recommended_tools:git|Git]]. Also be sure to review the best practices on the [[development:architecture:customizing_vufind|Customizing VuFind®]] page.
   * Keep local documentation -- for example, a wiki is a good way to list steps like import procedures for your institution.   * Keep local documentation -- for example, a wiki is a good way to list steps like import procedures for your institution.
   * Make sure everyone knows what tools to use.   * Make sure everyone knows what tools to use.
  
-===== Getting to know VuFind =====+===== Getting to know VuFind® =====
  
-  * Set up your e-mail client to filter the VuFind-General and VuFind-Tech lists into a folder.  There is an online search available of archives, and regular Google searching often turns up useful threads, but I found having local copies to be convenient and faster.  +  * Set up your e-mail client to filter the VuFind-General and VuFind-Tech lists into a folder.  There is an online search available of archives, and regular Google searching often turns up useful threads, but I found having local copies to be convenient and faster
-  * Get to know Solr, which contains the data for your VuFind installation. I liked the Solr wiki: http://wiki.apache.org/solr/FAQ+  * Join the community's Slack instance for real-time communication (see the [[https://vufind.org/vufind/support.html|support page]]). 
 +  * Attend a [[https://vufind.org/wiki/community_call|Community Call]] to meet the team and get a sense of how development is handled. 
 +  * Watch some [[:videos|Tutorial Videos]]
 +  * Get to know Solr, which contains the data for your VuFind® installation. I liked the Solr wiki: http://wiki.apache.org/solr/FAQ
   * Edit a few view templates to get the hang of how they work.  See the [[development:architecture:user_interface|user interface customization]] page for more details. Adding a new field to search results by following the [[development:howtos:displaying_a_custom_field|Displaying a Custom Field]] page might be a useful exercise.   * Edit a few view templates to get the hang of how they work.  See the [[development:architecture:user_interface|user interface customization]] page for more details. Adding a new field to search results by following the [[development:howtos:displaying_a_custom_field|Displaying a Custom Field]] page might be a useful exercise.
  
Line 25: Line 27:
   * Decide what order you want your facets to appear in and how you want them labelled, and edit the [[configuration:files:facets.ini]] file as described on the [[configuration:facets|customizing facets]] page.   * Decide what order you want your facets to appear in and how you want them labelled, and edit the [[configuration:files:facets.ini]] file as described on the [[configuration:facets|customizing facets]] page.
   * Decide whether you need to customize record display.  If so, you may want to build a custom [[development:plugins:record_drivers|record driver]] or modify the templates of an existing one.   * Decide whether you need to customize record display.  If so, you may want to build a custom [[development:plugins:record_drivers|record driver]] or modify the templates of an existing one.
-  * Decide if you want to tweak the relevance ranking.  See the [[configuration:search_customization|search customization]] page for details on how to do this.  If you like how another library's setup is working, just email them -- most VuFind users are willing to share their settings.+  * Decide if you want to tweak the relevance ranking.  See the [[configuration:search_customization|search customization]] page for details on how to do this.  If you like how another library's setup is working, just email them -- most VuFind® users are willing to share their settings.
   * Clean up any functions you aren't going to use right away, for example, "text this", by turning them off in [[configuration:files:config.ini]] or removing them from the appropriate template.  It's often better to eliminate a feature completely than to offer a feature that doesn't work the way you want or expect it to. Also, be sure to customize the default footer, as this contains some dummy links that don't actually go anywhere.   * Clean up any functions you aren't going to use right away, for example, "text this", by turning them off in [[configuration:files:config.ini]] or removing them from the appropriate template.  It's often better to eliminate a feature completely than to offer a feature that doesn't work the way you want or expect it to. Also, be sure to customize the default footer, as this contains some dummy links that don't actually go anywhere.
 +  * See the [[administration:production_checklist|Production Checklist]] for some additional details you should be sure to attend to prior to going live.
  
 ===== FAQs for Project Managers ===== ===== FAQs for Project Managers =====
Line 35: Line 37:
   A. You can see what searches are being sent to Solr in several ways:   A. You can see what searches are being sent to Solr in several ways:
  
- - Look in solr/jetty/logs or solr/logs (depending on your VuFind version) and you should see a file for each day there have been searches, filled with the queries as-sent. + - Look in solr/vufind/logs or solr/logs (depending on your VuFind® version) and you should see a file for each day there have been searches, filled with the queries as-sent. 
- - in [[configuration:files:config.ini]], turn debug=true near the top.  Now the queries will appear in your web browser as you search VuFind+ - in [[configuration:files:config.ini]], turn debug=true near the top.  Now the queries will appear in your web browser as you search VuFind®
  
-  Q. How do I change XXXX about VuFind+  Q. How do I change XXXX about VuFind®
  
   A. Here are the functions, directories and files you'll probably work with the most:   A. Here are the functions, directories and files you'll probably work with the most:
Line 51: Line 53:
  
 You may also want to change solr/biblio/conf/schema.xml, which controls how your data is processed at index time.  For example, to turn off "stemming," you would remove a filter from this schema.xml file.  You might find [[http://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters|this page]] helpful in understanding the processing involved. You may also want to change solr/biblio/conf/schema.xml, which controls how your data is processed at index time.  For example, to turn off "stemming," you would remove a filter from this schema.xml file.  You might find [[http://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters|this page]] helpful in understanding the processing involved.
 +
 ---- struct data ---- ---- struct data ----
 +properties.Page Owner : 
 ---- ----
  
administration/vufind_for_project_managers.1450716573.txt.gz · Last modified: 2015/12/21 16:49 by demiankatz