Hi,
when modifying, actually stealing from treebrowser :) a README file, I came to what if we make plugins webpages of identical format? They look a little bit careless now. If nobody minds I can do this for all plugins, treebrowser's one looks pretty suitable for me as a draft.
E-gards, Alexander
On Thu, 06 Oct 2011 00:23:54 +0400, Alexander wrote:
Hi,
when modifying, actually stealing from treebrowser :) a README file, I came to what if we make plugins webpages of identical format? They look a little bit careless now. If nobody minds I can do this for all plugins, treebrowser's one looks pretty suitable for me as a draft.
Good idea. I'm all for it, at least for my plugins: Addons and Spell Check.
Regards, Enrico
On 11-10-05 01:23 PM, Alexander Petukhov wrote:
Hi,
when modifying, actually stealing from treebrowser :) a README file, I came to what if we make plugins webpages of identical format? They look a little bit careless now. If nobody minds I can do this for all plugins, treebrowser's one looks pretty suitable for me as a draft.
I have no problem if you change the Devhelp one, though if we happen to move to github, we might want to consider converting them to markdown.
Cheers, Matthew Brush
On Wed, 05 Oct 2011 13:36:56 -0700, Matthew wrote:
On 11-10-05 01:23 PM, Alexander Petukhov wrote:
Hi,
when modifying, actually stealing from treebrowser :) a README file, I came to what if we make plugins webpages of identical format? They look a little bit careless now. If nobody minds I can do this for all plugins, treebrowser's one looks pretty suitable for me as a draft.
I have no problem if you change the Devhelp one, though if we happen to move to github, we might want to consider converting them to markdown.
Github supports RestructeredText as well and the READMEs are already RestructeredText so we nothing needs to be changed except renaming to README.rst.
Regards, Enrico
On 11-10-05 01:41 PM, Enrico Tröger wrote:
On Wed, 05 Oct 2011 13:36:56 -0700, Matthew wrote:
On 11-10-05 01:23 PM, Alexander Petukhov wrote:
Hi,
when modifying, actually stealing from treebrowser :) a README file, I came to what if we make plugins webpages of identical format? They look a little bit careless now. If nobody minds I can do this for all plugins, treebrowser's one looks pretty suitable for me as a draft.
I have no problem if you change the Devhelp one, though if we happen to move to github, we might want to consider converting them to markdown.
Github supports RestructeredText as well and the READMEs are already RestructeredText so we nothing needs to be changed except renaming to README.rst.
Ah nice! I didn't know that.
Cheers, Matthew Brush
Am 05.10.2011 22:36, schrieb Matthew Brush:
I have no problem if you change the Devhelp one, though if we happen to move to github, we might want to consider converting them to markdown.
Just a short answer: No. ;) (Long answer: we discussed this maybe a 100 times before. There is no real advantage of switching the markup language and ReST seems to be known by the most IIRC.)
Cheers, Frank
well, I uploaded a draft of a README to svn, in two words it's structure is like this:
- title - image (if applicable) - contents list - about - usage - requrements - contact info
About is a short paragraph about what a plugin is. Usage is the place where main information about plugin usage, tips, issues etc are supposed to be.
I thought we can avoid duplication of "Installation", "Downloads", "Bugs / Feature requests link" sections in every plugin as there are distinct pages for this stuff at a plugin web-site.
Let's discuss format and after that - reformat all READMEs.
p.s. GeanyLaTex and Geanylua have external links in README instead of actual text, it's ok probably but a link on Geanylua's page seems to be broken.
On 10/6/11 4:18 PM, Frank Lanitz wrote:
Am 06.10.2011 13:49, schrieb Alexander Petukhov:
well, I uploaded a draft of a README to svn,
I'd suggest to rename it with something like .sample or .template.
Cheers, Frank _______________________________________________ Geany-devel mailing list Geany-devel@uvena.de https://lists.uvena.de/cgi -bin/mailman/listinfo/geany-devel
I modified some of READMEs but they look a bit different from those converted to html locally at my box, a title has gone and image sizes are different. I'll better postpone this task till 0.21 plugins are out as I have some translation tasks now, but will return to it right after release.
By the way, can I gain more control on READMEs on a web-site to be able to modify and then upload and see the result instantly. I was told Dominic maintains this task now.
E-gards, Alexander
Am Montag, den 10.10.2011, 13:55 +0400 schrieb Alexander Petukhov:
By the way, can I gain more control on READMEs on a web-site to be able to modify and then upload and see the result instantly. I was told Dominic maintains this task now.
It's not my servers, so I'm not able to decide this. Pinging me on IRC (dmaphy) or Jabber (dmaphy@jabber.org) maybe is an alternative for that, even if no very good alternative.
Regards, Dominic
On Mon, 10 Oct 2011 22:41:19 +0200, Dominic wrote:
Am Montag, den 10.10.2011, 13:55 +0400 schrieb Alexander Petukhov:
By the way, can I gain more control on READMEs on a web-site to be able to modify and then upload and see the result instantly. I was told Dominic maintains this task now.
It's not my servers, so I'm not able to decide this. Pinging me on IRC
plugins.geany.org is hosted on Sourceforge.net, so having SVN write access (which you have) enables you as well to access the shell servers of Sourceforge to modify the files there. However, this won't help much because there are some scripts of Dominic which do some magic to the READMEs from SVN and then generate HTML which is rsync'ed to SF.
These scripts run on geany.org. But as this is my private server, I'm not so keen on giving everyone access to it. Sorry.
However, Dominic's scripts probably can run on another server as well, maybe even on SF's shell servers. Or the whole construct of generating those pages can be reworked to be more obvious, easier to test and so easier to improve.
Regards, Enrico
Am Montag, den 10.10.2011, 22:58 +0200 schrieb Enrico Tröger:
However, Dominic's scripts probably can run on another server as well, maybe even on SF's shell servers. Or the whole construct of generating those pages can be reworked to be more obvious, easier to test and so easier to improve.
First thing which wasn't that obvious for someone outstanding is, that the whole stuff is actually under version control since it's birth, the directory just needed to be checked out:
https://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/www/staging
I guess there weren't that much people who actually knew that. Maybe this one is easier to find:
https://github.com/dmaphy/plugins.geany.org
Improvement to that script-bundle are welcome anytime.
About reworking the whole concept:
I'd personally love the idea of the GitHub pages stuff, we maybe could do something on basis of that. There also were some nice ideas on IRC a few minutes ago which you guys maybe like to discuss here.
My suggestion is to start a rework with or after the Geany-Plugins 0.21 release.
Regards, Dominic
does github requires a special README format?
Am 05.10.2011 22:54 schrieb "Alexander Petukhov" devel@apetukhov.ru:
does github requires a special README format?
No. Plain text is fine as well as is Markdown or rst.
Take care
Alex