[ 
https://issues.apache.org/jira/browse/SAMOA-12?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14350449#comment-14350449
 ] 

Ted Dunning commented on SAMOA-12:
----------------------------------

I haven't been tracking closely, but if you host the web-site in the source 
repository, you can provide a very easy way for developers to push in changes.  
Drill is the canonical example project.  They use the same gh-pages convention 
that github uses, write all of the pages in mark-down and then use Jekyll to 
produce html which is driven into SVN for publication on apache.org.  The nice 
things about this include:

1) easy previewing via github mirrors

2) each changes via mechanisms that make sense to developers

3) markdown is easy to use, the pages can still be decorated as desired

4) Apache's confluence instance is dog slow, static pages coming out of Jekyll 
are lightning fast

5) Can use pull requests for updates on the web site, lots of github users are 
familiar with these conventions

Cons relative to this approach include:

1) this isn't as easy as a wiki

2) SVN check-in is still needed so the process is pretty manual

> Wiki for small how-tos
> ----------------------
>
>                 Key: SAMOA-12
>                 URL: https://issues.apache.org/jira/browse/SAMOA-12
>             Project: SAMOA
>          Issue Type: Task
>          Components: Infrastructure
>            Reporter: Gianmarco De Francisci Morales
>            Assignee: Gianmarco De Francisci Morales
>
> We need a place that is easy to modify (i.e., not the website) where to put 
> small how-tos and guides, mainly for the developers (e.g., how to do a 
> release, ho to build and make a change to the website).
> I have opened INFRA-9077 to ask for this.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to