forrest-user mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Crossley <>
Subject documentation additions and issue tracking (Was: App vs Data)
Date Sat, 21 May 2005 02:32:49 GMT
Addi wrote:
> I am planning on working on beginner, step by step type documentation 
> over time (as I learn the answers to my own questions).

It would be best if we created a shell of a new document
so that you and any others can work on it together.
More below about that ...

> I was wondering 
> if it would be OK to start a new issue in JIRA for an improvement in 
> docs on this.  That way, as people see problems that new users are 
> having in the lists, we can add them to the list of those issues in JIRA 
> to make it easier to keep track of it.  Is that appropriate or is there 
> another system set up for something like this?  I feel that keeping my 
> own scratchpad of issues is not terribly efficient, since I don't know 
> all the issues ...

This sounds like a good idea. I recommend separate issues
for each item. After we have incorporated that piece into
the documentation, then we close the issue. There is a category
for "Documentation". Give each issue a useful Summary title.
Keep the Description concise, and use Comments for more detail.
Link to mail list discussions where appropriate.

Are you working with the head of development, i.e. the
trunk of SVN?

> ... and it would suck for myself and someone else to be 
> writing docs on the same issue at the same time, thereby wasting 
> someone's time.

That is exactly why we try to work on every document
in the SVN repository. It is then collaborative.

It is also good practice to do it bit by bit, i.e.
progressively build the document rather than do a
whole swag by yourself, only to find that when it
comes time for us to commit the work, that you
have gone off track.

Remember too, that it is quite okay to have
"Fixme:" banners inside the published docs.

It would probably be useful to discuss the overall aim
of this beginners documentation. Will it be one document
in the main section of the website, will it be a HowTo.
That sort of discussion is more appropriate for the
dev mailing list.

This is exciting, thanks for helping out.


> What do you all recommend/already have in place?
> Thanks
> Addi
> Ross Gardler wrote:
> >Tim Williams wrote:
> >
> >>Embarrassingly enough, I was having a difficult time understanding the
> >>much simpler multiple statically built sites with one Forrest.  Ross'
> >>answer was helpful and I think my problem was that I never created a
> >>subdirectory to do the seed in so that I had a single "src" at a
> >>higher level than it should have been.  Having the "mkdir->cd->forrest
> >>see" and maybe a little explanation of having "multiple sites" would
> >>be helpful somewhere.
> >>
> >
> >We would love a patch for the docs making this clearer, sometimes we 
> >forget these critical points that are less obvious than we assume them 
> >to be.
> >
> >Ross

View raw message