Modify

Opened 9 years ago

Closed 3 years ago

#3725 closed enhancement (fixed)

NewHack should include stub in the wiki page detailing plugin enablement

Reported by: Jeff Hammel Owned by: Ryan J Ollos
Priority: low Component: TracHacksPlugin
Severity: normal Keywords:
Cc: Jun Omae Trac Release: 0.11

Description

all plugins are enabled in much the same way; the wiki page generated by going through the new-hack process should include a stub for how to enable the plugin, including relevant links to wiki pages on http://trac.edgewall.org

Attachments (0)

Change History (15)

comment:1 Changed 9 years ago by Noah Kantrowitz

Resolution: wontfix
Status: newclosed

The module name isn't known directly, so this really wouldn't work well.

comment:2 Changed 9 years ago by Jeff Hammel

Resolution: wontfix
Status: closedreopened

comment:3 Changed 9 years ago by Jeff Hammel

Owner: changed from Noah Kantrowitz to Jeff Hammel
Status: reopenednew

reassigning this to myself for study

comment:4 Changed 9 years ago by Jeff Hammel

Priority: normalhigh

comment:5 Changed 8 years ago by Jeff Hammel

Priority: highlow

de-prioritizing; have other tickets to look at right now

comment:6 Changed 8 years ago by Ryan J Ollos

Summary: new-hack should include stub in the wiki page detailing plugin enablementNewHack should include stub in the wiki page detailing plugin enablement

See also #3116.

comment:7 Changed 7 years ago by Ryan J Ollos

I'm in favor of this. Plugins are installed the same way, and a lot of pages have poorly written installation information. It would be better to point to a single page with plugin installation information, and have the author add their specific trac.ini options and installation of dependencies on their plugin's wiki page.

comment:8 Changed 7 years ago by Adrian Fritz

Some brainstorm ideas for NewHackTemplate "Install and Configure" section at NewHackTemplate/InstallAndConfigureProposal.

comment:9 Changed 7 years ago by Ryan J Ollos

I have a couple of comments/changes/suggestions:

  1. Rather than using a fake plugin/macro name, generate the steps for a real plugin/macro and use one that is simple to install, very mature, and generally useful to most people. That way, someone can run through the whole set of steps for a real plugin and rule out simple permission and environment configuration issues. If that is successful, it should be straightforward for someone to extrapolate the steps to another plugin. Perhaps the FootNoteMacro would be a good one to use for the example.
  2. My understanding is that there are really 3 ways to install: using easy_install, manual global installation, manual installation for a single Trac environment.
    1. I think that each option should be clearly outlined with a full set of steps for each, as opposed to having a single set of steps with switches depending on the mode of installation (i.e. if installing this way, do this, otherwise do this). For example:
      1. Manual installation - Global
      2. Manual installation - Single Trac Environment
      3. Automatic installation using easy_install
    2. It would be nice to provide general guidance as to which is best to use in certain situations, particularly for someone new who doesn't understand the trade-offs.
  3. Recommend that plugin authors/maintainers add a section, where appropriate, for an end user to test the plugin functionality. I have tried to do this with the FootNoteMacro, for instance: FootNoteMacro#Example.
  4. Should there be separate instructions for Windows vs Linux? I have never worked with Trac on Windows.

comment:10 Changed 7 years ago by Ryan J Ollos

I see that some work has been done here: Install. I'd be in favor of updating TracPlugins, renaming it to InstallingTracPlugins and then adding a stub to the NewHack template, such as:

== Installation ==
{{{
#!comment
Plugin authors should add plugin-specific installation information
below, including the module name for enabling the plugin by editing
trac.ini.
}}}
For generic installation information, see InstallingTracPlugin.

This section could be placed between the Source and Example sections.

comment:11 Changed 6 years ago by Ryan J Ollos

Additional relevant comments in comment:2:ticket:8524.

comment:12 Changed 5 years ago by Ryan J Ollos

Adrian: You may be interested in SiteUpgradeProposal, and feel free to add your suggestions to the Wish list.

comment:13 Changed 5 years ago by Ryan J Ollos

Owner: changed from Jeff Hammel to Michael Renzmann

comment:14 Changed 3 years ago by Ryan J Ollos

Cc: Jun Omae added; anonymous removed
Component: TracHacksTracHacksPlugin
Owner: changed from Michael Renzmann to Ryan J Ollos
Status: newaccepted

The NewHackTemplate@29 has an Installation section. The following could be the default string for the form:

Generic instructions for installing Trac plugins can be found on the TracPlugins page.

Generic instructions for installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

comment:15 Changed 3 years ago by Ryan J Ollos

Resolution: fixed
Status: acceptedclosed

In 14117:

3.0dev: Added a default string for the Installation section. Fixes #3725.

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain Ryan J Ollos.
The resolution will be deleted. Next status will be 'reopened'.

Add Comment


E-mail address and name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.