Difference between revisions of "GSoC Brainstorming"

From GeeklogWiki
Jump to: navigation, search
(dropped shopping cart plugin idea, added Undo function idea)
(translations idea has its own page now)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== New Ideas ==
 
== New Ideas ==
  
−
These are new and not fully fleshed-out ideas for the [[Google Summer of Code]]. Please note that these ideas are not directly eligible for GSoC as they are. They can be used as the starting point for a proper proposal, though, or for your inspiration if you'd like to submit a project idea of your own.
+
'''Please note:''' These are new and not fully fleshed-out project ideas for the [[Google Summer of Code]]. We think that these would be useful additions to Geeklog, so we are interested in project proposals based on these ideas. In the state that they are outlined here, though, they would require more work to turn them into a proper proposal. You can use them for inspiration for a project proposal of your own.
  
−
* Integrate '''Aloha Editor''', replacing FCKeditor as the "advanced" (WYSIWYG) editor in Geeklog.<br>As [http://eight.pairlist.net/pipermail/geeklog-devel/2011-January/005270.html discussed], this is probably not enough work to keep a student busy for 3 months. For a proper GSoC project, this would need to be expanded.
 
−
* Go '''Semantic Web'''. This is somewhat vague: Use available build blocks such as Apache Stanbol (see [http://www.geeklog.net/article.php/iks-workshop-amsterdam Report from the IKS Workshop in Amsterdam]) and the Aloha editor (see [http://semantic-editor.org/ Semantic Editor]) to add semantic information to articles. Possible uses: SEO, better linking between articles (also see [http://www.geeklog.net/comment.php?mode=view&cid=14099 What's Related]). Student should have a better idea of what "semantic web" is than the author of these sentences ...
 
−
* '''E-Mail Subsystem''': Geeklog sometimes has to send out a lot of emails. Instead of sending them all at once (and running into timeouts), we could queue them and send them out in batches. This queue should allow for other job types as well.
 
−
* '''Multi-site Setup''': Out-of-the-box support to run several websites off of one codebase. There's a [[Multi-Site Setup|hack]] for that, but it's a pain for upgrades and has unresolved issues with shared resources like files (favicon, XML sitemap, ...) and resources (images in articles, user photos, ...).
 
−
* '''Staging Support''': When making significant changes to a site, you don't want to do those on your "live" site, possibly disrupting its service. So you would set up a second site with pretty much the same setup as the original and make the changes there first. How could Geeklog (possibly the install script?) support such a setup? E.g. syncing changes back and forth.
 
−
* '''Admin toolbox''': A collection of mini-plugins for admin tasks (e.g. reset stats, change a default setting for all users, etc.). Should have super easy install, e.g. just drop (upload?) a file in a predefined directory.
 
−
* '''Migration from/to other systems''' is always a hot topic. How could we make that easier? We don't want to lock in users into Geeklog, so both import and export should be supported. Things like [http://www.geeklog.net/forum/viewtopic.php?showtopic=68851 the mtimport format] and [http://en.wikipedia.org/wiki/Content_Management_Interoperability_Services CMIS] come to mind.
 
−
* '''Multi user blogs''': Geeklog can handle blogs of several users, actually, if you give one topic to a user then it is almost unlimited. There are a few existing discussions on the forum and also feature requests concerning the improvement of user blogs. E.g. read only topics, using GL for a large site with many users. Basically it is a native function of GL but it need some improvement.
 
−
* Switching a site to '''Read-only mode''': Sometimes, it's time to close a site. You could take it offline entirely, but that would remove (possibly still useful) content from the web. Instead, it would be nice to have an option that disables all options to log in, sign up, add or edit content, etc.
 
−
* Implement an '''Undo Function''': Currently, as soon as you click on "save" for an object (story, block, user, ...) the old value or status of the object is gone and overwritten with whatever you changed last. It would be nice to have the ability to go back to a previous version when needed.
 
  
 +
=== Multi-Site Setup ===
  
−
=== Install Script Improvements ===
+
Out-of-the-box support to run several websites off of one codebase. There's a [[Multi-Site Setup|hack]] for that, but it's a pain for upgrades and has unresolved issues with shared resources like files (favicon, XML sitemap, ...) and resources (images in articles, user photos, ...).
  
−
The install script already does a lot more than simply install Geeklog. It is also used for upgrades and can help in migrating your Geeklog site from one server to another (MySQL only, though). This is a collection of ideas of what else it could. However, that list if somewhat incoherent and, in its current form, doesn't make for a great project. Maybe you can think of that piece that's missing here to make it a useful and promising GSoC project?
+
=== Staging Support ===
  
−
* '''Character Set Conversion''': Say you initially set up your Geeklog site to use ISO-8859-1 (or some other character set) and want to switch to UTF-8 now. All the content would have to be [http://www.geeklog.net/article.php/200410120657418 converted] - and the install script could do that for you.
+
When making significant changes to a site, you don't want to do those on your "live" site, possibly disrupting its service. So you would set up a second site with pretty much the same setup as the original and make the changes there first.
−
* '''Better error reporting''' on install problems (also: debugging, mostly for developers). This is sort of a bootstrapping problem: With the site being in the process of being installed, it's often tricky to provide useful error messages and a recovery from the problem.
 
−
* More specific and more conservative checks and recommendations for file and directory permissions: Right now, the install script gives rather liberal recommendations for permissions. It could check what's actually required and be more precise.
 
−
* Let the user continue with installation even when certain files/directories are not writable: Disable the feature that needs it, but finish the installation (where possible)
 
−
* Not sure if this is really a good idea but maybe the install script could even offer to try and set read/write permissions as required automatically.
 
−
* Build <tt>install/admin/info.php</tt> into the install script
 
−
* Add proper HTML title tags in the install script (all pages of the install script currently use the same title, which makes it confusing in the browser's history).
 
−
* A technicality: the plugin upload from within Geeklog uses the unpacker class, while the install script only relies on the PEAR Tar and Zip packages, so you may not be able to add some plugin archives in the install script (another bootstrap problem - the location of said class may not be known yet when it's needed).
 
−
* Add a "maintenance" option at the end of the install or upgrade process where we could offer (re)setting certain options, e.g. when a default changed, so that the user can opt to change the default for every user (or not).
 
−
* Allow for localized install data. Currently, a fresh setup is always in English, with English default stories, preferences, etc.
 
  
−
The vast majority of our users is using MySQL. So the following ideas, while useful for those not on MySQL, aren't that important to us right now:
+
How could Geeklog (possibly the install script?) support such a setup? E.g. syncing changes back and forth.
−
* '''Site Migration''' should also work for PostgreSQL and/or MS SQL
+
 
−
* '''Database Migration''': Allow switching from Postgres to MySQL or MS SQL or the other way around
+
=== Migration ===
 +
 
 +
'''Migration from/to other systems''' is always a hot topic. How could we make that easier? We don't want to lock in users into Geeklog, so both import and export should be supported.
 +
 
 +
Things like [http://www.geeklog.net/forum/viewtopic.php?showtopic=68851 the mtimport format] and [http://en.wikipedia.org/wiki/Content_Management_Interoperability_Services CMIS] come to mind.
 +
 
 +
=== Alternative WYSIWYG Editor ===
 +
 
 +
Integrate '''Aloha Editor''', replacing FCKeditor/CKEditor as the "advanced" (WYSIWYG) editor in Geeklog.
 +
 
 +
As [http://eight.pairlist.net/pipermail/geeklog-devel/2011-January/005270.html discussed], this is probably not enough work to keep a student busy for 3 months. For a proper GSoC project, this would need to be expanded upon.
 +
 
 +
=== Semantic Web ===
 +
 
 +
Go '''Semantic Web'''. This is a somewhat vague idea: Use available building blocks such as Apache Stanbol (see [http://www.geeklog.net/article.php/iks-workshop-amsterdam Report from the IKS Workshop in Amsterdam]) and the Aloha editor (see [http://semantic-editor.org/ Semantic Editor]) to add semantic information to articles.
 +
 
 +
Possible uses: SEO, better linking between articles (also see [http://www.geeklog.net/comment.php?mode=view&cid=14099 What's Related]).
 +
 
 +
A student working on this project should have a better idea of what "semantic web" is than the author of these sentences ...
 +
 
 +
=== Mass-E-Mail Support ===
 +
 
 +
Implement an '''E-Mail Subsystem''': Geeklog sometimes has to send out a lot of emails. Instead of sending them all at once (and running into timeouts), we could queue them and send them out in batches. This queue should allow for other job types as well.
 +
 
 +
=== Admin Toolbox ===
 +
 
 +
A collection of mini-plugins for admin tasks (e.g. reset stats, change a default setting for all users, etc.). Should have super easy install, e.g. just drop (upload?) a file in a predefined directory.
 +
 
 +
=== Multi-User Blogs ===
 +
 
 +
Geeklog can handle blogs of several users. Actually, if you give one topic to a user then it is almost unlimited. There are a few existing discussions on the forum and also feature requests concerning the improvement of user blogs. E.g. read only topics, using GL for a large site with many users. Basically it is a native function of GL but it need some improvement.
 +
 
 +
=== Read-Only Mode ===
 +
 
 +
Switching a site to '''Read-only mode''': Sometimes, it's time to close a site. You could take it offline entirely, but that would remove (possibly still useful) content from the web. Instead, it would be nice to have an option that disables all options to log in, sign up, add or edit content, etc.
 +
 
 +
=== Undo ===
 +
 
 +
Implement an '''Undo Function''': Currently, as soon as you click on "save" for an object (story, block, user, ...) the old value or status of the object is gone and overwritten with whatever you changed last. It would be nice to have the ability to go back to a previous version when needed.
 +
 
 +
This could possibly be expanded to a full-fledged revision control or something like the [http://wiki.geeklog.net/index.php?title=GSoC_Brainstorming&action=history history] function of MediaWiki.
 +
 
 +
There are already some hooks in place to help implement this, see [[PLG_itemSaved]], although they are not yet implemented everywhere.
 +
 
 +
=== Articles Plugin ===
 +
 
 +
Articles (also called ''stories'') are built into Geeklog. There's no good reason for this, other than that it has always been like that. The idea here is to move all article support to a plugin. In addition to it being more consistent, Geeklog would also become more modular and you could disable articles in order to use Geeklog only as a web framework.
 +
 
 +
A big concern with this idea is backward compatibility due to the necessary change of the URLs of all the articles on a site. This would need to be addressed in a way such that it also works for sites that can not use URL rewriting.
 +
 
 +
Note that this idea is not new and even somewhat controversial. It may also not as easy to implement as it may sound at first.
  
  

Latest revision as of 15:28, 29 March 2013

New Ideas

Please note: These are new and not fully fleshed-out project ideas for the Google Summer of Code. We think that these would be useful additions to Geeklog, so we are interested in project proposals based on these ideas. In the state that they are outlined here, though, they would require more work to turn them into a proper proposal. You can use them for inspiration for a project proposal of your own.


Multi-Site Setup

Out-of-the-box support to run several websites off of one codebase. There's a hack for that, but it's a pain for upgrades and has unresolved issues with shared resources like files (favicon, XML sitemap, ...) and resources (images in articles, user photos, ...).

Staging Support

When making significant changes to a site, you don't want to do those on your "live" site, possibly disrupting its service. So you would set up a second site with pretty much the same setup as the original and make the changes there first.

How could Geeklog (possibly the install script?) support such a setup? E.g. syncing changes back and forth.

Migration

Migration from/to other systems is always a hot topic. How could we make that easier? We don't want to lock in users into Geeklog, so both import and export should be supported.

Things like the mtimport format and CMIS come to mind.

Alternative WYSIWYG Editor

Integrate Aloha Editor, replacing FCKeditor/CKEditor as the "advanced" (WYSIWYG) editor in Geeklog.

As discussed, this is probably not enough work to keep a student busy for 3 months. For a proper GSoC project, this would need to be expanded upon.

Semantic Web

Go Semantic Web. This is a somewhat vague idea: Use available building blocks such as Apache Stanbol (see Report from the IKS Workshop in Amsterdam) and the Aloha editor (see Semantic Editor) to add semantic information to articles.

Possible uses: SEO, better linking between articles (also see What's Related).

A student working on this project should have a better idea of what "semantic web" is than the author of these sentences ...

Mass-E-Mail Support

Implement an E-Mail Subsystem: Geeklog sometimes has to send out a lot of emails. Instead of sending them all at once (and running into timeouts), we could queue them and send them out in batches. This queue should allow for other job types as well.

Admin Toolbox

A collection of mini-plugins for admin tasks (e.g. reset stats, change a default setting for all users, etc.). Should have super easy install, e.g. just drop (upload?) a file in a predefined directory.

Multi-User Blogs

Geeklog can handle blogs of several users. Actually, if you give one topic to a user then it is almost unlimited. There are a few existing discussions on the forum and also feature requests concerning the improvement of user blogs. E.g. read only topics, using GL for a large site with many users. Basically it is a native function of GL but it need some improvement.

Read-Only Mode

Switching a site to Read-only mode: Sometimes, it's time to close a site. You could take it offline entirely, but that would remove (possibly still useful) content from the web. Instead, it would be nice to have an option that disables all options to log in, sign up, add or edit content, etc.

Undo

Implement an Undo Function: Currently, as soon as you click on "save" for an object (story, block, user, ...) the old value or status of the object is gone and overwritten with whatever you changed last. It would be nice to have the ability to go back to a previous version when needed.

This could possibly be expanded to a full-fledged revision control or something like the history function of MediaWiki.

There are already some hooks in place to help implement this, see PLG_itemSaved, although they are not yet implemented everywhere.

Articles Plugin

Articles (also called stories) are built into Geeklog. There's no good reason for this, other than that it has always been like that. The idea here is to move all article support to a plugin. In addition to it being more consistent, Geeklog would also become more modular and you could disable articles in order to use Geeklog only as a web framework.

A big concern with this idea is backward compatibility due to the necessary change of the URLs of all the articles on a site. This would need to be addressed in a way such that it also works for sites that can not use URL rewriting.

Note that this idea is not new and even somewhat controversial. It may also not as easy to implement as it may sound at first.


Leftover Ideas

This is a list of other ideas for projects for the Google Summer of Code that have been tossed around in previous years but did not seem so important at this point in time.

If you plan to apply for one of these projects you should provide a good use case. Otherwise, these ideas could serve as a starting point for your own project idea.

Retrieved from "http://gwiki3.thatlinuxbox.com/index.php?title=GSoC_Brainstorming&oldid=6260"