Apache Gora
  1. Apache Gora
  2. GORA-106

Migrate Gora website documentation to Apache CMS

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 0.2
    • Fix Version/s: 0.4
    • Component/s: documentation, website
    • Labels:
      None

      Description

      I know in the past we've discussed the pro's and con's of the website etc. However, currently it is a bit of a pain to actually edit/update, build and commit/publish web content. This is a pain for committers never-mind any newer Gora users who may just wish to contribute documentation in a pain/hassle free manner. To illustrate this point I've pasted a conversation with a pro-Apache CMS ASF guy, whom I asked to look into the Gora documentation.

      So, right now, there's no README.
      build.xml suggests I use ant, so I did
      But no readme means the first ``ant'' will complain
      about forrest missing, and I'll say:
      Meh. All I wanted is fix a typo.

      You have to make it easy for people to contribute,
      and you're not!

      If you're living in a happy java world, everyone will
      have maven, so maven might be the way to go. If 277
      packages is all I need, then so be it, but I'll already
      have them installed.

      I fired up this email when I started the forrest checkout
      it's only done now, after 3:26.53.
      Let's see what else breaks

      AN EXCEPTION! And a backtrace! OH I LOVE THOSE!

      BUILD FAILED
      /home/igalic/src/asf/gora-site/build.xml:27: Execute failed: java.io.IOException: Cannot run program "../forrest/bin/forrest" (in directory "/home/igalic/src/asf/gora-site/author"): java.io.IOException: error=2, No such file or directory

      I touch author, but that doesn't bring me anywhere.
      Of course the error is that ant or forrest can't deal with relative paths,
      so I run it again as:

      igalic@tynix ~/src/asf/gora-site (svn)-[site:1240598] % ant -Dforrest.home=$( readlink -f ../forrest)

      And it fails again, because I didn't build forrest.
      By now I wonder if there's a forrest package in Fedora, but
      of course there isn't. So let's build forrest.

      Which in turn fails because Fedora has some weird
      JAVA_HOME pointing to an OpenJDK JRE.

      Back to building gora-site.
      It builds in 19s and I'm impressed, or hope I have reason to be.

      I go in my browser to /home/igalic/src/asf/gora-site/author/build/site
      expecting it to break horribly because it's using fixed URLs
      but it works. I'm impressed. I'm also impressed by its ugly,
      but that's beside the point. It works. And it only took me
      30 minutes to get there.

      At this stage I let out a long sigh, and thought that it was about time to open this issue, taking the following into account.
      We need to "make it easy"

      • for people to contribute a small fix
      • for developers to actually write docs

      For the latter it should be in a form and a format they are used to, something that doesn't break their habits. If anyone has the habit of writing stuff down in notepad then markdown might be ideal... therefore we arrive @ APACHE CMS.

      http://www.apache.org/dev/cms
      https://blogs.apache.org/infra/entry/the_asf_cms

      1. GORA-106.patch
        127 kB
        Lewis John McGibbney

        Issue Links

          Activity

          Lewis John McGibbney made changes -
          Status In Progress [ 3 ] Resolved [ 5 ]
          Resolution Fixed [ 1 ]
          Lewis John McGibbney made changes -
          Link This issue is related to INFRA-6009 [ INFRA-6009 ]
          Lewis John McGibbney made changes -
          Status Open [ 1 ] In Progress [ 3 ]
          Lewis John McGibbney made changes -
          Assignee Lewis John McGibbney [ lewismc ]
          Lewis John McGibbney made changes -
          Fix Version/s 0.4 [ 12319890 ]
          Fix Version/s 0.3 [ 12317954 ]
          Gavin made changes -
          Workflow jira [ 12657552 ] no-reopen-closed, patch-avail [ 12735264 ]
          Lewis John McGibbney made changes -
          Link This issue supercedes GORA-96 [ GORA-96 ]
          Hide
          Lewis John McGibbney added a comment -

          OK troops, managed to locate some nice time saving resources for us to use to map the legacy forrest xdoc's to markdown.

          https://svn.apache.org/repos/infra/websites/cms/conversion-utilities/

          In particular the xslt written by Sam Ruby

          https://svn.apache.org/repos/infra/websites/cms/conversion-utilities/anakia2markdown.xslt

          Show
          Lewis John McGibbney added a comment - OK troops, managed to locate some nice time saving resources for us to use to map the legacy forrest xdoc's to markdown. https://svn.apache.org/repos/infra/websites/cms/conversion-utilities/ In particular the xslt written by Sam Ruby https://svn.apache.org/repos/infra/websites/cms/conversion-utilities/anakia2markdown.xslt
          Lewis John McGibbney made changes -
          Field Original Value New Value
          Attachment GORA-106.patch [ 12524453 ]
          Hide
          Lewis John McGibbney added a comment -

          Hi Andrew. OK this is the patch I was talking about. As you'll see it's a WIP and needs ALOT of work.

          Show
          Lewis John McGibbney added a comment - Hi Andrew. OK this is the patch I was talking about. As you'll see it's a WIP and needs ALOT of work.
          Hide
          Lewis John McGibbney added a comment -

          Aye keeping it simple is the aim of the game (from my pov anyway) with this one. I'm very happy to get the gora CMS up and running.

          Hi Andrew, I've been working on a patch for this, which in its current form is nothing more than a simple phasing of html to markdown, so if you give me until tomorrow then I'll upload what I've got OK... and yeah it would be great if we could work on this together.

          Show
          Lewis John McGibbney added a comment - Aye keeping it simple is the aim of the game (from my pov anyway) with this one. I'm very happy to get the gora CMS up and running. Hi Andrew, I've been working on a patch for this, which in its current form is nothing more than a simple phasing of html to markdown, so if you give me until tomorrow then I'll upload what I've got OK... and yeah it would be great if we could work on this together.
          Hide
          Andrew Hart added a comment -

          Big +1 for using Bootstrap! The flexibility is incredible. And, if you're turned off by the millions of similar-looking bootstrap sites, sites like http://lavishbootstrap.com make it dead simple to quickly customize the stock Bootstrap CSS.

          Show
          Andrew Hart added a comment - Big +1 for using Bootstrap! The flexibility is incredible. And, if you're turned off by the millions of similar-looking bootstrap sites, sites like http://lavishbootstrap.com make it dead simple to quickly customize the stock Bootstrap CSS.
          Hide
          Enis Soztutar added a comment -

          How about just using Twitter's Bootstrap. http://twitter.github.com/bootstrap/

          It provides slick looking project web sites, and is very easy to use.

          Show
          Enis Soztutar added a comment - How about just using Twitter's Bootstrap. http://twitter.github.com/bootstrap/ It provides slick looking project web sites, and is very easy to use.
          Hide
          Andrew Hart added a comment -

          Hey Lewis, I like it! (All except the Flash carousel , there are plenty of alternatives though)

          If you want a hand with this, I'd be happy to help out here! How would you see things breaking down, is there something we could do in parallel?

          Show
          Andrew Hart added a comment - Hey Lewis, I like it! (All except the Flash carousel , there are plenty of alternatives though) If you want a hand with this, I'd be happy to help out here! How would you see things breaking down, is there something we could do in parallel?
          Hide
          Lewis John McGibbney added a comment -

          Hi Henry,
          All of this content will be changed to ASF and Apache Gora including the graphics :0)

          Show
          Lewis John McGibbney added a comment - Hi Henry, All of this content will be changed to ASF and Apache Gora including the graphics :0)
          Hide
          Henry Saputra added a comment -

          Website builder company?

          Show
          Henry Saputra added a comment - Website builder company?
          Hide
          Lewis John McGibbney added a comment -

          I was looking for a quick and easy, yet impressive look for the new site. On my journey's I came across

          http://www.templatemo.com/templates/templatemo_281_chrome/

          What do you guys think?

          Show
          Lewis John McGibbney added a comment - I was looking for a quick and easy, yet impressive look for the new site. On my journey's I came across http://www.templatemo.com/templates/templatemo_281_chrome/ What do you guys think?
          Lewis John McGibbney created issue -

            People

            • Assignee:
              Lewis John McGibbney
              Reporter:
              Lewis John McGibbney
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development