[prev in list] [next in list] [prev in thread] [next in thread]
List: fop-dev
Subject: RE: FOP Release Automation
From: Robert Meyer <rmeyer () hotmail ! co ! uk>
Date: 2014-05-30 21:34:40
Message-ID: DUB407-EAS366623C972840E2F1368C586270 () phx ! gbl
[Download RAW message or body]
I'll definitely look into those. I'm going to be away on holiday now for a week or so \
but will continue once I get back.
Many thanks!
Robert
________________________________
From: Clay Leeds<mailto:the.webmaestro@gmail.com>
Sent: 5/30/2014 17:24
To: Apache FOP<mailto:fop-dev@xmlgraphics.apache.org>
Subject: Re: FOP Release Automation
Agreed, ‘some' people wouldn't be happy with that. ;-)
I wonder if the CMS Web interface could be extended to allow for a few keywords like \
FOP_VERSION, FOP_REVISION, FOP_BRANCH, etc.
The CMS tool's WYSIWYG interface indicates it uses the Wysiwym MarkDown Editor, which \
is extensible:
https://web.archive.org/web/20110121060932/http://wmd-editor.com/
(site's down & hasn't been updated since 2011)...
or
https://code.google.com/p/wmd/
We might still need to do some ANT hanky panky, but at least if we could leverage \
WMD's extensibility it would help us get where we're trying to go?
Clay
On May 30, 2014, at 7:19 AM, Robert Meyer <rmeyer@hotmail.co.uk> wrote:
> Hi,
>
> I like the simplicity of your idea, but the web interface is not so easy to dismiss \
> unfortunately.
> If you do have a copy with those tags in, if any changes are made on the web \
> interface then that copy would become out of date.
> We could always shutdown the web interface, but I don't think too many people would \
> be happy with that ;-)
> Regards,
>
> Robert
>
> From: simonsteiner1984@gmail.com
> To: fop-dev@xmlgraphics.apache.org
> Subject: RE: FOP Release Automation
> Date: Fri, 30 May 2014 14:48:15 +0100
>
> Hi,
>
> Simple way is to store docs inside fop repo:
>
> Fop/docs/index.markdown
>
> Inside markdown file you reference ant properties eg:
> ${version}
>
> Then you call which does ant expandproperties and calls markdown to html tool:
> ant docs
>
> Then you call which does a zip, scp and unzip of html files to web server:
> ant upload-docs
>
> This method doesn't support web interface of editing files but I don't see how this \
> is really needed. If I submit a patch to fop it should also contain doc changes \
> rather than having separate repo and patch for that.
> Thanks
>
> From: Robert Meyer [mailto:rmeyer@hotmail.co.uk]
> Sent: 30 May 2014 14:05
> To: fop-dev@xmlgraphics.apache.org
> Subject: RE: FOP Release Automation
>
> Hi,
>
> After investigating your suggestions Clay I have found that svn-hooks can't be used \
> for the purpose we require unfortunately as it may lead to problems with how SVN \
> operates and also may have some unexpected results with files being committed. This \
> is stated in the documentation under "Creating Repository Hooks" highlighted in the \
> warning red box further down:
> http://www-inst.eecs.berkeley.edu/~cs61b/fa09/docs/svn-book-html-chunk/svn.reposadmin.create.html
>
> Pascal, I agree that the process is fairly straightforward, but I have been asked \
> to automate this further so am just looking into ideas presently.
> I think a possible way forward then would be to use your suggestion Pascal of \
> placing the versioned docs for the site inside the FOP repository for their \
> associated version. These can then be referenced using the svn-externals from the \
> main site repository.
> In addition to this, the main site files (which would need to be updated) could \
> contain tags for the last three versions which would be replaced using Clay's \
> markdown pre-processor suggestion. The pre-processor would replace the tags with \
> values stored in a properties file in the main site repository.
> To create a release, the user would need to update the svn-external references to \
> account for the new version and update the properties file for tag replacement. \
> When the properties file is pushed it will be read by the custom markdown \
> pre-processor and display the new version when rendered.
> Those two stages could be done using a single script to simplify things further, \
> but the main complication is getting the markdown pre-processor working. From \
> looking at this page:
> http://www.apache.org/dev/cmsref.html#markdown
>
> I am guessing we use PyPy (Python Markdown) which supports extensions, so I will \
> look at this shortly to try out a small example and investigate the feasibility of \
> doing this. There is also the matter of updating the versioned documents for each \
> FOP when a new version is released, but maybe this could be done with the \
> pre-processor as well.
> Anyway, let me know what you think.
>
> Regards,
>
> Robert
[Attachment #3 (unknown)]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<div>
<div style="font-family: Calibri,sans-serif; font-size: 11pt;">I'll definitely look \
into those. I'm going to be away on holiday now for a week or so but will continue \
once I get back.<br> <br>
Many thanks!<br>
<br>
Robert</div>
</div>
<div dir="ltr">
<hr>
<span style="font-family: Calibri,sans-serif; font-size: 11pt; font-weight: \
bold;">From: </span><span style="font-family: Calibri,sans-serif; font-size: \
11pt;"><a href="mailto:the.webmaestro@gmail.com">Clay Leeds</a></span><br> <span \
style="font-family: Calibri,sans-serif; font-size: 11pt; font-weight: bold;">Sent: \
</span><span style="font-family: Calibri,sans-serif; font-size: \
11pt;">5/30/2014 17:24</span><br> <span style="font-family: \
Calibri,sans-serif; font-size: 11pt; font-weight: bold;">To: </span><span \
style="font-family: Calibri,sans-serif; font-size: 11pt;"><a \
href="mailto:fop-dev@xmlgraphics.apache.org">Apache FOP</a></span><br> <span \
style="font-family: Calibri,sans-serif; font-size: 11pt; font-weight: bold;">Subject: \
</span><span style="font-family: Calibri,sans-serif; font-size: 11pt;">Re: FOP \
Release Automation</span><br> <br>
</div>
<div style="word-wrap:break-word">
<div>Agreed, ‘some' people wouldn't be happy with that. ;-)</div>
<div><br>
</div>
I wonder if the CMS Web interface could be extended to allow for a few keywords \
like FOP_VERSION, FOP_REVISION, FOP_BRANCH, etc. <div><br>
</div>
<div>The CMS tool's WYSIWYG interface indicates it uses the Wysiwym MarkDown Editor, \
which is extensible:</div> <div><br>
</div>
<div><a href="https://web.archive.org/web/20110121060932/http://wmd-editor.com/">https://web.archive.org/web/20110121060932/http://wmd-editor.com/</a></div>
<div><br>
</div>
<div>(site's down & hasn't been updated since 2011)...</div>
<div><br>
</div>
<div>or</div>
<div><br>
</div>
<div><a href="https://code.google.com/p/wmd/">https://code.google.com/p/wmd/</a></div>
<div><br>
</div>
<div>We might still need to do some ANT hanky panky, but at least if we could \
leverage WMD's extensibility it would help us get where we're trying to go?<br> \
<div><br> </div>
<div>Clay<br>
<div><br>
<div>
<div>On May 30, 2014, at 7:19 AM, Robert Meyer <<a \
href="mailto:rmeyer@hotmail.co.uk">rmeyer@hotmail.co.uk</a>> wrote:</div> \
<blockquote type="cite"> <div class="x_hmmessage" style="font-size:12pt; \
font-family:Calibri; font-style:normal; font-variant:normal; font-weight:normal; \
letter-spacing:normal; line-height:normal; orphans:auto; text-align:start; \
text-indent:0px; text-transform:none; white-space:normal; widows:auto; \
word-spacing:0px"> <div dir="ltr">Hi,<br>
<br>
I like the simplicity of your idea, but the web interface is not so easy to dismiss \
unfortunately.<br> <br>
If you do have a copy with those tags in, if any changes are made on the web \
interface then that copy would become out of date.<br> <br>
We could always shutdown the web interface, but I don't think too many people would \
be happy with that ;-)<br> <br>
Regards,<br>
<br>
Robert<br>
<br>
<div>
<hr id="x_stopSpelling">
From: <a href="mailto:simonsteiner1984@gmail.com">simonsteiner1984@gmail.com</a><br>
To: <a href="mailto:fop-dev@xmlgraphics.apache.org">fop-dev@xmlgraphics.apache.org</a><br>
Subject: RE: FOP Release Automation<br>
Date: Fri, 30 May 2014 14:48:15 +0100<br>
<br>
<div class="x_ecxWordSection1">
<div style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)">Hi,</span></div> <p \
class="x_ecxMsoNormal" style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)"> </span></p> <div \
style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)">Simple way is to store docs \
inside fop repo:</span></div> <p class="x_ecxMsoNormal" style="margin:0px; \
padding:0px"><span style="font-size:11pt; font-family:Calibri,sans-serif; \
color:rgb(31,73,125)"> </span></p> <div style="margin:0px; padding:0px"><span \
style="font-size:11pt; font-family:Calibri,sans-serif; \
color:rgb(31,73,125)">Fop/docs/index.markdown</span></div> <p class="x_ecxMsoNormal" \
style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)"> </span></p> <div \
style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)">Inside markdown file you \
reference ant properties eg:</span></div> <div style="margin:0px; padding:0px"><span \
style="font-size:11pt; font-family:Calibri,sans-serif; \
color:rgb(31,73,125)">${version}</span></div> <p class="x_ecxMsoNormal" \
style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)"> </span></p> <div \
style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)">Then you call which does ant \
expandproperties and calls markdown to html tool:</span></div> <div \
style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)">ant docs</span></div> <p \
class="x_ecxMsoNormal" style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)"> </span></p> <div \
style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)">Then you call which does a zip, \
scp and unzip of html files to web server:</span></div> <div style="margin:0px; \
padding:0px"><span style="font-size:11pt; font-family:Calibri,sans-serif; \
color:rgb(31,73,125)">ant upload-docs</span></div> <p class="x_ecxMsoNormal" \
style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)"> </span></p> <div \
style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)">This method doesn't support web \
interface of editing files but I don't see how this is really needed.</span></div> \
<div style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)">If I submit a patch to fop it \
should also contain doc changes rather than having separate repo and patch for \
that.</span></div> <p class="x_ecxMsoNormal" style="margin:0px; padding:0px"><span \
style="font-size:11pt; font-family:Calibri,sans-serif; \
color:rgb(31,73,125)"> </span></p> <div style="margin:0px; padding:0px"><span \
style="font-size:11pt; font-family:Calibri,sans-serif; \
color:rgb(31,73,125)">Thanks</span></div> <p class="x_ecxMsoNormal" \
style="margin:0px; padding:0px"><span style="font-size:11pt; \
font-family:Calibri,sans-serif; color:rgb(31,73,125)"> </span></p> <div>
<div style="border-style:solid none none; border-top-color:rgb(225,225,225); \
border-top-width:1pt; padding:3pt 0cm 0cm"> <div style="margin:0px; \
padding:0px"><b><span style="font-size:11pt; \
font-family:Calibri,sans-serif">From:</span></b><span style="font-size:11pt; \
font-family:Calibri,sans-serif"><span \
class="x_Apple-converted-space"> </span>Robert Meyer [<a \
href="mailto:rmeyer@hotmail.co.uk">mailto:rmeyer@hotmail.co.uk</a>]<span \
class="x_Apple-converted-space"> </span><br> <b>Sent:</b><span \
class="x_Apple-converted-space"> </span>30 May 2014 14:05<br> <b>To:</b><span \
class="x_Apple-converted-space"> </span><a \
href="mailto:fop-dev@xmlgraphics.apache.org">fop-dev@xmlgraphics.apache.org</a><br> \
<b>Subject:</b><span class="x_Apple-converted-space"> </span>RE: FOP Release \
Automation</span></div> </div>
</div>
<p class="x_ecxMsoNormal" style="margin:0px; padding:0px"> </p>
<div>
<div style="margin:0px; padding:0px"><span \
style="font-family:Calibri,sans-serif">Hi,<br> <br>
After investigating your suggestions Clay I have found that svn-hooks can't be used \
for the purpose we require unfortunately as it may lead to problems with how SVN \
operates and also may have some unexpected results with files being committed. This \
is stated in the documentation under "Creating Repository Hooks" \
highlighted in the warning red box further down:<br> <br>
<a href="http://www-inst.eecs.berkeley.edu/~cs61b/fa09/docs/svn-book-html-chunk/svn.reposadmin.create.html" \
target="_blank">http://www-inst.eecs.berkeley.edu/~cs61b/fa09/docs/svn-book-html-chunk/svn.reposadmin.create.html</a><br>
<br>
Pascal, I agree that the process is fairly straightforward, but I have been asked to \
automate this further so am just looking into ideas presently.<br> <br>
I think a possible way forward then would be to use your suggestion Pascal of placing \
the versioned docs for the site inside the FOP repository for their associated \
version. These can then be referenced using the svn-externals from the main site \
repository.<br> <br>
In addition to this, the main site files (which would need to be updated) could \
contain tags for the last three versions which would be replaced using Clay's \
markdown pre-processor suggestion. The pre-processor would replace the tags with \
values stored in a properties file in the main site repository.<br>
<br>
To create a release, the user would need to update the svn-external references to \
account for the new version and update the properties file for tag replacement. When \
the properties file is pushed it will be read by the custom markdown pre-processor \
and display the new version when rendered.<br>
<br>
Those two stages could be done using a single script to simplify things further, but \
the main complication is getting the markdown pre-processor working. From looking at \
this page:<br> <br>
<a href="http://www.apache.org/dev/cmsref.html#markdown" \
target="_blank">http://www.apache.org/dev/cmsref.html#markdown</a><br> <br>
I am guessing we use PyPy (Python Markdown) which supports extensions, so I will look \
at this shortly to try out a small example and investigate the feasibility of doing \
this. There is also the matter of updating the versioned documents for each FOP when \
a new version is released, but maybe this could be done with the pre-processor as \
well.<br> <br>
Anyway, let me know what you think.<br>
<br>
Regards,<br>
<br>
Robert</span></div>
</div>
</div>
</div>
</div>
</div>
</blockquote>
</div>
<br>
</div>
</div>
</div>
</div>
</body>
</html>
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic