tomee-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Carlos Chacín <ccha...@gmail.com>
Subject Re: [GitHub] tomee issue #234: TOMEE-2316 Convert Markdown files to Asciidoc in the docs ...
Date Fri, 07 Dec 2018 06:32:56 GMT
I'll create a ticket to put the headers as a code comment instead, I
noticed that is also appearing in the current markdown docs:

http://tomee.apache.org/tomee-8.0/docs/tomee-webapp.html

On Thu, Dec 6, 2018 at 1:47 PM David Blevins <david.blevins@gmail.com>
wrote:

> Note the license header should only be visible in the source file as a
> comment that isn't shown on each page.  We have the licensing terms covered
> for the published website via the footer, which states:
>
>  - Copyright © 1999-2016 The Apache Software Foundation, Licensed under
> the Apache License, Version 2.0.
>
> We probably should update the copyright year however :)
>
> --
> David Blevins
> http://twitter.com/dblevins
> http://www.tomitribe.com
>
> > On Dec 5, 2018, at 11:53 PM, Carlos Chacín <cchacin@gmail.com> wrote:
> >
> > Hi, I separated the work in 13 PRs and they are tested locally using
> JBake
> >
> >       • PR #244
> >       • PR #245
> >       • PR #246
> >       • PR #247
> >       • PR #248
> >       • PR #249
> >       • PR #250
> >       • PR #251
> >       • PR #252
> >       • PR #253
> >       • PR #254
> >       • PR #255
> >       • PR #256
> > I tried to find a good balance between number of files vs. number of PRs
> but if you folks think that I should create yet smaller PRs let me know (I
> have an script for that process)
> >
> > There already a few noticeable improvements in this migration:
> >
> > The ASF license header was shown as follow:
> >
> > <image.png>
> > And now is shown in a nicer asciidoc admonition:
> >
> > <image.png>
> >
> > The JPA section was not shown in the documentation, and now it's there:
> >
> > <image.png>
> > New Links appearing in the respective sections:
> >
> > <image.png>
> >
> > <image.png>
> > <image.png>
> > <image.png>
> >
> > On Wed, Dec 5, 2018 at 7:57 PM Carlos Chacín <cchacin@gmail.com> wrote:
> > Thanks David for the feedback and the recommendations, I'll polish
> everything in the current open PR/branch and after having everything
> working with JBake I'll split the work in smaller separate PRs.
> >
> > On Wed, Dec 5, 2018 at 6:37 PM David Blevins <david.blevins@gmail.com>
> wrote:
> > Thank you for the PR, Carlos!
> >
> > Give this a try with the site generator:
> >
> >  - https://github.com/apache/tomee-site-generator
> >
> > JBake defines header for Asciidoc slightly differently than it does for
> Markdown.  Check out:
> >
> >  - https://jbake.org/docs/2.6.3/#metadata_header
> >
> > Specifically, there's no "~~~~~~" terminator and all JBake properties
> must start with ":jbake-".  Important note that ":index-group:" is fine as
> that is one of our headers.
> >
> > The site generator will create a clone of TomEE master in
> repos/tomee-8.0/.  You can pull your PR into that using this script:
> >
> >  - https://gist.github.com/dblevins/6e255634d84914beb051a4b3858ebfb4
> >
> > And then hammer away till it all looks good.
> >
> > I probably would recommend doing them in batches as you mention in your
> PR, just because you're scripting this and no one is perfect and each page
> should be reviewed with a human eye before being merged or going live.  I
> think one pig PR is a huge time commitment to review in one shot.
> >
> > Huge thank you for taking this on!!!!
> >
> >
> > --
> > David Blevins
> > http://twitter.com/dblevins
> > http://www.tomitribe.com
> >
> > > On Dec 4, 2018, at 1:02 AM, cchacin <git@git.apache.org> wrote:
> > >
> > > Github user cchacin commented on the issue:
> > >
> > >    https://github.com/apache/tomee/pull/234
> > >
> > >    I'm happy to split this in several PRs if the changes make sense
> > >
> > >
> > > ---
> >
> >
> >
> > --
> > Carlos Chacin
> > Software Developer Engineering
> >
> >
> > --
> > Carlos Chacin
> > Software Developer Engineering
>
>

-- 
*Carlos Chacin*
Software Developer Engineering

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message