wiki:SiteUpgradeProposal

Version 67 (modified by figaro, 8 years ago) (diff)

Cosmetic changes

Site Upgrade Proposal

Implementation of this proposal is in progress.

This page documents the proposed work for upgrading trac-hacks.org from 0.10.6dev to 1.0.

The first stage of the project will be to upgrade the site to a newer version of Trac. The installed plugins will need to be adapted to the newer version of Trac and extensive testing will need to be done before the upgraded site can go live.

The second stage of the project will improve the site by addressing the open issues and perhaps even tackling some features from the wish list.

Milestone 1 (completed)

  • DONE Upgrade server to Debian Squeeze.
  • DONE Subversion: 1.5.1 -> 1.6.18.
  • DONE Python: 2.5 -> 2.6
  • DONE PostgreSQL ? -> PostgreSQL 8.4

Milestone 2

  • DONE Upgrade Trac to version 1.0.
  • DONE Re-enable XmlRpcPlugin.
  • TODO Upgrade plugins to work with Trac 1.0. This work is being tracked in #10193 and #11949.

Milestone 3

Milestone 4

  • TODO Update all plugins to be compatible with Trac 1.2.
  • TODO Upgrade trac-hacks.org to 1.2 (#12171).

Milestone 5

Open Issues

There are a number of open defects and enhancements that we may want to address during the upgrade:

  • Many plugins don't have a license. An idea outlined in #9805 is to force the user to either specify a license or accept a default license when creating a NewHack.
  • Spam continues to be a problem. Upgrading to the t:SpamFilter might improve the issue, but the captcha from the latest th:SpamFilter plugin as observed on t.e.o can be frustrating experience and we don't want to risk driving away users.
    • A related issue is that many tickets are created by anonymous and anonymous often does not follow-up when more information or feedback is requested. We could require users to create an account before they can create a ticket, which might cut down on newticket spam as well as these abandoned tickets.
    • Deleting and marking spam is tedious. After deleting the spam ticket, comment or edit; we have to navigate to the Monitoring panel on the Admin page and then manually locate the entry in the logs. It would be much easier if the delete button also flagged the entry as spam, and there was a delete checkbox on the logs page so that this is a one-step operation.
  • There are a number projects that are no longer maintained, have been supplanted by another project and are just taking up space at this point.
    • We should have a process for removing old projects. Perhaps we should have a policy of reviewing and voting on them, a notification should be placed on the page and then a prescribed waiting period elapsed before eventually deleting them. Obsolete plugins with no license would have even more reason to be deleted (see also #9805).
    • Projects that have no source, often because the links to an external site are dead, are being tagged with tag:nosource. Tickets are being opened to notify authors of pending project deletion, and are being tagged with tag:pending-deletion.
    • The Apache Software Foundation moves a project to the Attic when it is no longer maintained. For us, the Attic could be a wiki page prefix and path prefix in the repository (or perhaps the path should be deleted and links to the repository pegged). Ideally the pages in the Attic would be filtered from search results unless explicitly requested. Changing the prefix of the page and repository path wouldn't be required if we just used tags.

Policies and Guidelines

On several occasions questions have come up about proper use of the site and how it should be administered. This suggests we need more site policies, and the philosophy of trac-hacks suggests that these policies be formed by the community.

Wish List

  • Hosting the #trac IRC logs using the IrcLogsPlugin (mailing list discussion).
    • osimons suggested that we host the IRC bot on a server other than the t-h.o server since running a bot presents potential security concerns. This might be accomplished with a minimal VPS and sending the logs to t-h.o through RPC after implementation of #10118.
  • Hosting a pastebin using the TracPastePlugin (mailing list discussion).
  • Expanded support for creating polls and voting on projects and tickets (#6471). t.e.o uses the VotePlugin (#8717), so it is probably pretty stable. FiveStarVotePlugin is another that we could consider using. The PollMacro is currently installed on t.h.o, and EasyPollMacro appears to build on it and add more functionality.
    • It would be cool if the Top 50 plugins are somehow installed (automatically with their latest [stable?] version) on a demo-site for seeing how they look like and for playing with and testing. That would give the user a chance to evaluate the functionality before spending the time with installing.
      • Is there a way to show a download/svn-update/checkout statistics counter for each plugin? This would also be something like a "judge".
  • Add site analytics.
  • Tools to facilitate code reviews, such as the CodeReviewerPlugin.
  • Support for Git and Hg (#9831) in addition to SVN. Is it practical to have live mirrors, do we settle on a single DVCS or do we just give the user a choice of which to work with?
    • Trac supports multiple repositories since Trac 0.12, so we no longer need to have a single repository for all of trac-hacks.org (though having a single repository can be an easy way to checkout all of the plugins at one time).
    • Sync to BitBucket and GitHub when plugins are hosted externally: GitHubSyncPlugin, BitbucketSyncPlugin.
    • Show ChangeLogs on trac-hacks wiki pages for plugins hosted externally (#7650).
  • Support for translated wiki pages
  • TICKET_EDIT_COMMENT should be set for correcting typos, at least for own comments (t:#10909 proposes adding a TICKET_EDIT_OWN_COMMENT permission).
  • BookmarkPlugin: ability to bookmark each page.
  • WikiGoodiesPlugin: additional wiki formatting and macros.
  • BadLinksPlugin: for cleaning out dead links to externally hosted plugins.
  • BackLinksMacro: list the wiki pages referring to the current page, which helps in keeping t.h. page referrals consistent.
  • Autowikify all tags: #10197.
  • HacksManagement
    • The TracHacksPlugin provides the NewHack page. More extensive hack management features could be added, such as the following:
      • Delete a hack (particularly useful for cleaning up spam): remove project from SVN, remove wiki page, remove component (#7511).
      • Track unmaintained plugins by contacting authors if there is no activity after a set amount of time.
  • Support for development space for t-h.o plugins. (sandinak)
    • We shouldn't do the work inside our 'deliverable' space ( svn/{plugin}/ } .. be nice to have say /svn/devel/{plugin} .. and we can merge across to our production environments.
  • Mechanism for users to subscribe to notifications of new plugin releases, and for plugin authors to control when new release notifications are sent out (#6476 is related).
  • Allow authors to edit their own log messages.
  • The NewHack template Recent Changes heading should link to the revision log, for example ContextMenuPlugin#RecentChanges.
  • RepoSearchPlugin was previously enabled, as described on the TracHacks@43 page, and is a feature we'll want to keep in mind for the future.
  • PyPI Integration: make it easier for authors to publish from the trac-hacks repository to PyPI, allow a PyPI location to be registered via the NewHack form, promote and encourage links from hack pages to PyPI, documentation for plugin authors/maintainers on how to publish to PyPI.
  • Move all users wiki pages to wiki/users/ or wiki/TracUsers, to keep the TitleIndex more organized and hierarchical.
  • Authentication through external providers such as GitHub and BitBucket.
  • Improve search functionality: the search functionality is currently rudimentary and requires an update to allow for more granular search, such as within attachments.
  • Don't allow anonymous users to change the state of tickets. Users often accept tickets forgetting they are not logged in, resulting in a ticket being assigned to anonymous. Fixed in the latest workflow.

Tickets for TracHacks

Ticket Summary Status Owner Type Priority Severity
#10861 Develop rules that govern code contributions new task normal normal
#13460 Upgrade to Trac 1.4 accepted Ryan J Ollos task normal normal
#13482 Replace reports 9 and 10 with custom queries new Ryan J Ollos enhancement normal normal
#13562 Cannot change password for t-h.org accepted Ryan J Ollos defect normal normal
#14246 HackIndex page defaults to showing hacks for fersions 1.0 and 1.2 only new Ryan J Ollos enhancement normal normal

Tickets for TracHacksPlugin

Ticket Summary Status Owner Type Priority Severity
#7980 Provide a rolling list of newest hacks new Ryan J Ollos enhancement normal normal
#11467 Add option "Hack is hosted externally" new Ryan J Ollos enhancement normal normal
#11490 Render username in comment field as a link new Ryan J Ollos enhancement normal normal
#11660 NewHack form should have a license selection new Ryan J Ollos enhancement normal normal
#13098 Append needsadoption tag to components with no owner new Ryan J Ollos enhancement normal normal
#13182 Display change log entries from GitHub new Ryan J Ollos enhancement normal normal
#13286 ListHacks macro should specify number of hacks for each category new Ryan J Ollos enhancement normal normal
#13419 Support renaming hacks new Ryan J Ollos enhancement normal normal
#13766 Update authz file when maintainer is changed accepted Ryan J Ollos defect normal normal
#13822 Convert templates to Jinja2 new task normal normal
#13830 Close open tickets when deleting a plugin new Ryan J Ollos enhancement normal normal