You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomee.apache.org by Marius Kruger <am...@gmail.com> on 2011/07/22 05:03:05 UTC
Re: Website - markdown
sorry for resurrecting an old thread again
(I'm catching up on unread openejb mails in the background).
I think we should add the instructions for contributing to the new site
below on the new site and maybe even link
to it from the current site..
On 12 June 2011 20:28, Karan Malhi <ka...@gmail.com> wrote:
> Infra was super quick with our request. Here is the first (and only)
> page of our site in staging
>
> https://svn.apache.org/repos/infra/websites/staging/openejb/trunk/content/index.html
> Will try and document stuff, doc might be a helpful to understand the
> whole thing (not that complicated though - but I am a stickler for
> docs as I tend to forget how I did it in the first place :) )
> The basic idea is :-
>
> - Created directory structure in
> https://svn.apache.org/repos/asf/openejb/site/trunk
>
> -- trunk/content (and its sub directories)- contains all .mdtext
> files (which contain markdown). You could throw in non .mdtext files
> which will be copied over as is
> -- trunk/lib - contains some perl scripts
> -- trunk/template - contains our template within which our html
> generated from .mdtext gets injected (ideally we have everything as
> markdown and zero html files)
>
> - You could checkout the site from
> https://svn.apache.org/repos/asf/openejb/site/trunk, modify anything
> and checkin (hopefully we should not be checking in html files, ideal
> situation would be to have everything in markdown). Staging will
> automatically be updated for you (and its pretty quick)- here is what
> you should see after the update - http://openejb.staging.apache.org/
> - You should also visit https://cms.apache.org/openejb/ . From that
> page, drag the javascript bookmarklet to your browser toolbar . Now
> open http://openejb.staging.apache.org/ and click on the bookmarklet.
> This opens the webgui system, which allows you to edit the files with
> a web editor (pretty slick, isnt it)
>
> I am also going to play with certain conversion utilities to convert
> from cwiki format to markdown. This will help us migrating our
> existing docs to markdown.
>
> Right now our template (trunk/template/basic.html) is just a copy of
> the lucy template, need to change this.
>
>
> On Fri, Jun 10, 2011 at 8:44 PM, Karan Malhi <ka...@gmail.com>
> wrote:
> >
> > Filed an issue at Infra to request our own staging site. There is a lot
> of work to sift through existing content and get into staging going forward.
> Its an excellent opportunity to clean up our website and add relevant stuff.
> Its going to be a long process.
> > https://issues.apache.org/jira/browse/INFRA-3674
> >
> > On Fri, Jun 10, 2011 at 8:25 PM, Karan Malhi <ka...@gmail.com>
> wrote:
> >>
> >> David introduced me to joes4 at #asfinfra on irc. I asked him a few
> questions, thought I will share with you
> >> <dblevins> kmalhi: meet joes4
> >> <kmalhi> hi joes4
> >> <joes4> hiya
> >> <dblevins> he wrote the CMS
> >> <kmalhi> was trying to convert our site to cms
> >> <kmalhi> have created the directory structure, but am not sure about
> certain things, mainly process
> >> <joes4> well as i mentioned to dblevins the docroot is the content/ dir
> >> <dblevins> kmalhi: i asked joes4 where we need to put the html and he
> said it goes in the trunk/content/ dir
> >> <dblevins> jinx
> >> <joes4> the build system will walk the content dir and feed it to the
> view that matches the path
> >> <joes4> on a per-file basis
> >> <joes4> by default the build system will copy any files that don't match
> a configured path
> >> <kmalhi> path will be configured in path.pm?
> >> <joes4> yes with a regexp match
> >> <joes4> your existing patterns array has a regexp for .mdtext
> >> <kmalhi> so I could name my files .md and as long as my regexp matches
> that extension, build system will convert markdown to html?
> >> <joes4> yes but don't do that as it breaks conventions in the webgui
> >> <kmalhi> okay, so keep it mdtext
> >> <joes4> +1
> >> <kmalhi> where does the build system keep the generated html?
> >> <joes4> at
> https://svn.apache.org/repos/infra/websites/staging/$project/
> >> <joes4> it also gets built to http://$project.staging.apache.org/
> >> <kmalhi> would we need to request our site first? I do not see openejb
> in there
> >> <joes4> yes file an infra jira
> >> <kmalhi> so I should basically just keep the markdown files and the dir
> structure etc in version control, html will always get generated, so does
> not need to be in svn, correct?
> >> <joes4> right
> >> <kmalhi> do you know if anybody has already documented their
> experience/steps of converting to cms? is there a known link you know of?
> >> <joes4> aries might be a good people to talk to for converting from
> confluence
> >> <kmalhi> what happens to the existing html content?
> >> <kmalhi> okay, thx
> >> <joes4> kmalhi: it gets deleted
> >> <joes4> the cms is authoritative for the entire site
> >> <kmalhi> I meant, the existing html generated by the auto-export plugin,
> which resides in people.apache.org
> >> <kmalhi> would we need to convert it to markdown first?
> >> <joes4> kmalhi: not necessarily
> >> <joes4> as i said the build system will copy by default
> >> <kmalhi> joes4, ah
> >> <joes4> so if you just put raw html into content/
> >> <joes4> it will get copied over to the site
> >> <kmalhi> very cool!!
> >> <joes4> and there's no need to switch over the live site until you're
> ready
> >> <kmalhi> once we get the site, we should be able to use the javascript
> bookmarklet, right?
> >> <joes4> setting up the cms will give you a staging site to work on
> >> <joes4> yes
> >> <kmalhi> joes4, am going to try and document my steps of converting, let
> me know if there is a place I could put it for other people to refer to it,
> will definitely be putting up a page on our site
> >> <joes4> someone put some cms info on the general moin wiki
> >> <joes4> lemme see if i can find it
> >> <joes4> http://wiki.apache.org/general/ApacheCms2010
> >> <kmalhi> Thanks a bunch joes4
> >>
> >> On Wed, Jun 8, 2011 at 12:20 PM, Andre Brito <
> andrebritofonseca@gmail.com> wrote:
> >>>
> >>> Hey Karan, keep us posted. I'll write some examples using Markdown too
> in the
> >>> weekends and I'd like to know where are your progress.
> >>>
> >>> --
> >>> View this message in context:
> http://openejb.979440.n4.nabble.com/Website-markdown-tp3581524p3582966.html
> >>> Sent from the OpenEJB Dev mailing list archive at Nabble.com.
> >>
> >>
> >>
> >> --
> >> Karan Singh Malhi
> >
> >
> >
> > --
> > Karan Singh Malhi
>
>
>
> --
> Karan Singh Malhi
>
--
<>< Marius ><>
Re: Website - markdown
Posted by David Blevins <da...@gmail.com>.
That's a good idea. If you want to collect the info from the thread and draft up a little markdown text with the details, I'd be happy to check it in. The process would probably be the same as code contributions (check out the docs, add/edit, 'svn diff > foo.patch', attach to jira). We can then just link to the info about the new site.
No worries on resurrecting old threads. I pull threads from 1+ years ago sometimes.
-David
On Jul 21, 2011, at 8:03 PM, Marius Kruger wrote:
> sorry for resurrecting an old thread again
> (I'm catching up on unread openejb mails in the background).
>
> I think we should add the instructions for contributing to the new site
> below on the new site and maybe even link
> to it from the current site..
>
>
> On 12 June 2011 20:28, Karan Malhi <ka...@gmail.com> wrote:
>
>> Infra was super quick with our request. Here is the first (and only)
>> page of our site in staging
>>
>> https://svn.apache.org/repos/infra/websites/staging/openejb/trunk/content/index.html
>> Will try and document stuff, doc might be a helpful to understand the
>> whole thing (not that complicated though - but I am a stickler for
>> docs as I tend to forget how I did it in the first place :) )
>> The basic idea is :-
>>
>> - Created directory structure in
>> https://svn.apache.org/repos/asf/openejb/site/trunk
>>
>> -- trunk/content (and its sub directories)- contains all .mdtext
>> files (which contain markdown). You could throw in non .mdtext files
>> which will be copied over as is
>> -- trunk/lib - contains some perl scripts
>> -- trunk/template - contains our template within which our html
>> generated from .mdtext gets injected (ideally we have everything as
>> markdown and zero html files)
>>
>> - You could checkout the site from
>> https://svn.apache.org/repos/asf/openejb/site/trunk, modify anything
>> and checkin (hopefully we should not be checking in html files, ideal
>> situation would be to have everything in markdown). Staging will
>> automatically be updated for you (and its pretty quick)- here is what
>> you should see after the update - http://openejb.staging.apache.org/
>> - You should also visit https://cms.apache.org/openejb/ . From that
>> page, drag the javascript bookmarklet to your browser toolbar . Now
>> open http://openejb.staging.apache.org/ and click on the bookmarklet.
>> This opens the webgui system, which allows you to edit the files with
>> a web editor (pretty slick, isnt it)
>>
>> I am also going to play with certain conversion utilities to convert
>> from cwiki format to markdown. This will help us migrating our
>> existing docs to markdown.
>>
>> Right now our template (trunk/template/basic.html) is just a copy of
>> the lucy template, need to change this.
>>
>>
>> On Fri, Jun 10, 2011 at 8:44 PM, Karan Malhi <ka...@gmail.com>
>> wrote:
>>>
>>> Filed an issue at Infra to request our own staging site. There is a lot
>> of work to sift through existing content and get into staging going forward.
>> Its an excellent opportunity to clean up our website and add relevant stuff.
>> Its going to be a long process.
>>> https://issues.apache.org/jira/browse/INFRA-3674
>>>
>>> On Fri, Jun 10, 2011 at 8:25 PM, Karan Malhi <ka...@gmail.com>
>> wrote:
>>>>
>>>> David introduced me to joes4 at #asfinfra on irc. I asked him a few
>> questions, thought I will share with you
>>>> <dblevins> kmalhi: meet joes4
>>>> <kmalhi> hi joes4
>>>> <joes4> hiya
>>>> <dblevins> he wrote the CMS
>>>> <kmalhi> was trying to convert our site to cms
>>>> <kmalhi> have created the directory structure, but am not sure about
>> certain things, mainly process
>>>> <joes4> well as i mentioned to dblevins the docroot is the content/ dir
>>>> <dblevins> kmalhi: i asked joes4 where we need to put the html and he
>> said it goes in the trunk/content/ dir
>>>> <dblevins> jinx
>>>> <joes4> the build system will walk the content dir and feed it to the
>> view that matches the path
>>>> <joes4> on a per-file basis
>>>> <joes4> by default the build system will copy any files that don't match
>> a configured path
>>>> <kmalhi> path will be configured in path.pm?
>>>> <joes4> yes with a regexp match
>>>> <joes4> your existing patterns array has a regexp for .mdtext
>>>> <kmalhi> so I could name my files .md and as long as my regexp matches
>> that extension, build system will convert markdown to html?
>>>> <joes4> yes but don't do that as it breaks conventions in the webgui
>>>> <kmalhi> okay, so keep it mdtext
>>>> <joes4> +1
>>>> <kmalhi> where does the build system keep the generated html?
>>>> <joes4> at
>> https://svn.apache.org/repos/infra/websites/staging/$project/
>>>> <joes4> it also gets built to http://$project.staging.apache.org/
>>>> <kmalhi> would we need to request our site first? I do not see openejb
>> in there
>>>> <joes4> yes file an infra jira
>>>> <kmalhi> so I should basically just keep the markdown files and the dir
>> structure etc in version control, html will always get generated, so does
>> not need to be in svn, correct?
>>>> <joes4> right
>>>> <kmalhi> do you know if anybody has already documented their
>> experience/steps of converting to cms? is there a known link you know of?
>>>> <joes4> aries might be a good people to talk to for converting from
>> confluence
>>>> <kmalhi> what happens to the existing html content?
>>>> <kmalhi> okay, thx
>>>> <joes4> kmalhi: it gets deleted
>>>> <joes4> the cms is authoritative for the entire site
>>>> <kmalhi> I meant, the existing html generated by the auto-export plugin,
>> which resides in people.apache.org
>>>> <kmalhi> would we need to convert it to markdown first?
>>>> <joes4> kmalhi: not necessarily
>>>> <joes4> as i said the build system will copy by default
>>>> <kmalhi> joes4, ah
>>>> <joes4> so if you just put raw html into content/
>>>> <joes4> it will get copied over to the site
>>>> <kmalhi> very cool!!
>>>> <joes4> and there's no need to switch over the live site until you're
>> ready
>>>> <kmalhi> once we get the site, we should be able to use the javascript
>> bookmarklet, right?
>>>> <joes4> setting up the cms will give you a staging site to work on
>>>> <joes4> yes
>>>> <kmalhi> joes4, am going to try and document my steps of converting, let
>> me know if there is a place I could put it for other people to refer to it,
>> will definitely be putting up a page on our site
>>>> <joes4> someone put some cms info on the general moin wiki
>>>> <joes4> lemme see if i can find it
>>>> <joes4> http://wiki.apache.org/general/ApacheCms2010
>>>> <kmalhi> Thanks a bunch joes4
>>>>
>>>> On Wed, Jun 8, 2011 at 12:20 PM, Andre Brito <
>> andrebritofonseca@gmail.com> wrote:
>>>>>
>>>>> Hey Karan, keep us posted. I'll write some examples using Markdown too
>> in the
>>>>> weekends and I'd like to know where are your progress.
>>>>>
>>>>> --
>>>>> View this message in context:
>> http://openejb.979440.n4.nabble.com/Website-markdown-tp3581524p3582966.html
>>>>> Sent from the OpenEJB Dev mailing list archive at Nabble.com.
>>>>
>>>>
>>>>
>>>> --
>>>> Karan Singh Malhi
>>>
>>>
>>>
>>> --
>>> Karan Singh Malhi
>>
>>
>>
>> --
>> Karan Singh Malhi
>>
>
>
>
> --
> <>< Marius ><>