[FLOW3-general] Best Practice for a plugin-based app in flow3

[Zach Davis]

Robert,

I can help with this.

I spent a few hours today digging into what it would take to help with 
documentation. I've cloned the FLOW3.org git repository onto one of our 
development servers, imported the site data to get a working flow3.org 
site, and invested some time in getting sphinx working. I've got this at 
a point now where I can make a change to one of the .rst files, execute 
the flow3 documentation:render command, and then execute 
documentation:import and see the rendered doc bundles on the frontend 
(the doc package could probably benefit from better default 
configuration to make this easier for other people who want to 
contribute). It seems that documentation:import can't be called multiple 
times without emptying the DB and re-importing the site, but perhaps 
that's just a problem with my environment.

In any case, I'm happy to take a stab at writing some documentation. I 
figure that I'll start with something relatively easy (I was thinking 
the Command-line page might be a good one to start with), render the 
docs on our dev server, and push a commit to gerrit with a link back to 
the rendered page so reviewers can see what it looks like.

If you want me to proceed with this, I think it would be helpful to get 
some general content-guidance from you or Karsten. I'm confident that I 
can work through the code and describe the functionality/usage for most 
features based on what I see and what I know about how FLOW3 works. 
However, in many cases, it would be useful if a core FLOW3 dev could 
give me a list of 4 or 5 bullet points (keep them simple and brief, so 
it doesn't become too burdensome) of things you'd like to see covered on 
a specific page, and I'll try to structure the content around those key 
points.

I don't have a ton of extra time these days, so I can't promise you I'll 
be able to devote days and days to this. However, I'm a pretty quick 
writer, and I'm happy to spend some time on this on my evenings and 
weekends.

best,
Zach


Robert Lemke wrote:
> Personally I feel a lot under pressure as we also need to work on Phoenix and
> a lot of other side aspects. So, I appreciate any help for solving this.
>
> What would be especially helpful at this point:
>
>   - someone who takes care of the FLOW3 website and produces (or lets produce) a lot
>     more information about the core features, where to find help, how to contribute etc.
>   - we also need a good tutorial / screen cast section which allows the community to easily
>     contribute tutorials and screen casts
>   - someone who looks at the documentation as a whole with a skilled eye and coordinates
>     further steps
>
> Anyway, documentation is the next top feature on our todo list.