Andreas/tracks
1
0
Fork 0
mirror of https://github.com/TracksApp/tracks.git synced 2025-09-22 05:50:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add a help page with link to the user manual and other sources

Browse source
This commit is contained in:
Jyri-Petteri Paloposki 2020-07-23 22:20:28 +03:00
parent 5be552a71f
commit cf5751cdce
5 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
app/controllers/integrations_controller.rb
View file

@ -12,6 +12,10 @@ class IntegrationsController < ApplicationController
@page_title = 'TRACKS::REST API Documentation' @page_title = 'TRACKS::REST API Documentation'
end end
def help
@page_title = 'TRACKS::Help'
end
def search_plugin def search_plugin
@icon_data = [File.open(File.join(Rails.root, 'app', 'assets', 'images', 'done.png')).read]. @icon_data = [File.open(File.join(Rails.root, 'app', 'assets', 'images', 'done.png')).read].
pack('m').gsub(/\n/, '') pack('m').gsub(/\n/, '')

13
app/views/integrations/help.html.erb Normal file
View file

@ -0,0 +1,13 @@
<h1>Help</h1>
<p>You can find information on the usage in the <a href="https://github.com/TracksApp/tracks/wiki/User-manual">User manual</a> in the project GitHub wiki.</p>
<p>If you encounter a bug or have a feature request, please report it in the <a href="https://github.com/TracksApp/tracks/issues">issue queue</a>.</p>
<p>We gladly welcome all contributions to Tracks. Check the <a href="https://www.getontracks.org/contribute/">project website</a> for further information. You can also come discuss with the community:</p>
<ul>
<li><a href="http://groups.google.com/group/TracksApp">Mailing list</a></li>
<li><a href="https://gitter.im/TracksApp/tracks">Gitter chat</a></li>
<li><a href="https://webchat.freenode.net/#Tracks">IRC channel #Tracks@FreeNode</li>
</ul>

1
app/views/shared/_navbar.html.erb
View file

@ -51,6 +51,7 @@
<%= t('layouts.navigation.help') %> <span class="caret"></span> <%= t('layouts.navigation.help') %> <span class="caret"></span>
</a> </a>
<ul class="dropdown-menu"> <ul class="dropdown-menu">
<li><%= link_to t('layouts.navigation.help_page'), help_path %></li>
<li><%= link_to t('layouts.navigation.integrations_'), integrations_path %></li> <li><%= link_to t('layouts.navigation.integrations_'), integrations_path %></li>
<li><%= link_to t('layouts.navigation.api_docs'), rest_api_docs_path %></li> <li><%= link_to t('layouts.navigation.api_docs'), rest_api_docs_path %></li>
</ul> </ul>

1
config/locales/en.yml
View file

@ -401,6 +401,7 @@ en:
import_title: Import data import_title: Import data
preferences: Preferences preferences: Preferences
integrations_: Integrate Tracks integrations_: Integrate Tracks
help_page: Help
feeds_title: See a list of available feeds feeds_title: See a list of available feeds
calendar_title: Calendar of due actions calendar_title: Calendar of due actions
completed_tasks: Done completed_tasks: Done

1
config/routes.rb
View file

@ -25,6 +25,7 @@ Rails.application.routes.draw do
get 'data/xml_export' => 'data#xml_export' get 'data/xml_export' => 'data#xml_export'
get 'data/csv_actions' => 'data#csv_actions' get 'data/csv_actions' => 'data#csv_actions'
get 'help' => "integrations#help"
get 'integrations' => "integrations#index" get 'integrations' => "integrations#index"
get 'integrations/rest_api' => "integrations#rest_api", :as => 'rest_api_docs' get 'integrations/rest_api' => "integrations#rest_api", :as => 'rest_api_docs'
post 'integrations/cloudmailin' => 'integrations#cloudmailin' post 'integrations/cloudmailin' => 'integrations#cloudmailin'