headers
Jason Hines | 1 May 2004 19:47

Proposed Doc Structure

Following discussion re: documentation on IRC, I propose the following 
structure to be maintained in all package books.

1. About
  - Preface
  - CVS Information
  - Copyright
  - License
2. Introduction
  - Purpose
  - Theory
3. Synopsis
  - Usage
  - Code Examples
4. Future
  - Future Improvements
  - Recommendations
5. Problems
  - Known Problems
  - Possible Solutions

And if relevant:
6. References
X. Whatever else

I've added this skeleton structure to 'init' package.  Main point was 
that I don't think Theory and Purpose belong in separate chapters.  I 
think they can both belong to an Introduction chapter.
Permalink | Reply | 1 comment |
headers
alex black | 1 May 2004 20:00

Re: Proposed Doc Structure

I am literally walking out the door, but:

> 1. About
> - Preface
> - CVS Information
> - Copyright
> - License

Good.

> 2. Introduction
> - Purpose
> - Theory

Theory may be appropriate as a "separate" chapter. I don't particularly love
introduction because it doesn't really tell you what's there.

Maybe:

Package Overview
    Purpose
    Files (description of each file)
    Classes

Don't think API docs when you see files and classes - I'd like these to be
written overviews.

Then

Theory
(Continue reading)

Permalink | Reply | 0 comments |
headers
Jason Hines | 1 May 2004 20:24

docsite and mod_rewrite


One of the issues lingering with DocSite was linking documentation 
pages.  DocSite was looking for get vars $package and $chapter.

I've just added an .htaccess file to docsite which allows linking doc 
pages like so:

[package]/[chapter].html

IE:
http://docs.binarycloud.com/init/Introduction.html

jason
Permalink | Reply | 0 comments |
headers
Jean-Christophe Michel | 4 May 2004 01:58
Favicon

storage in testsite

Hi,

I broke the no commit rule to add some minor corrections so as
testsite/app/storagetest works a little more.
We could improve it with some more fieds in the form and a navigation
node to see previous and next entities.
--

-- 
Jean-Christophe Michel <jc.michel@...>
Symétrie
Permalink | Reply | 0 comments |
headers
Manuel Holtgrewe | 6 May 2004 01:35

Documentation run

Hi

I just wrote documentation about binarycloud-init and binarycloud-env. 
Please, all, have a look and tell me what you think. Especially have a 
look at the diagram in binarycloud-init's "Introduction" and tell me 
what I got wrong.

I think if we get this diagram (included in media as a graffle file) 
perfect (i.e. no depedencies there like Init depending on Log, but 
being the fundamental layer - there is something foul about this), we 
can have a cleaner system.

Also note the long problem part in binarycloud-env (also some in 
binarycloud-init, I think). Feel free to add oddities there.

Regards

Manuel
Permalink | Reply | 0 comments |
headers
Daniel Bondurant | 6 May 2004 22:01

testsite

Hi,
I have a few questions about testsite

1. the bc_auth/user and bc_auth/user_assignment are empty in CVS.
Is this correct?  If I am not missing something, you can't log into
testsite since there are no users.

2.  PagedTable demo uses the creole_test database.  Can we switch it is
bc_auth or bc_testsite or something like that?  I think everything for
testsite should be in one db for easy setup.

should I be entering this stuff in the tracker?

- daniel
Permalink | Reply | 8 comments |
headers
Jason Hines | 7 May 2004 07:16

Re: testsite

Daniel Bondurant wrote:
> I have a few questions about testsite
> 
> 1. the bc_auth/user and bc_auth/user_assignment are empty in CVS.

> Is this correct?  If I am not missing something, you can't log into
> testsite since there are no users.

There is a testsite/perm/perm.sql which contains some values for testsite.

> 2.  PagedTable demo uses the creole_test database.  Can we switch it is
> bc_auth or bc_testsite or something like that?  I think everything for
> testsite should be in one db for easy setup.

Yeah testsite needs some cleanup before a release.

> should I be entering this stuff in the tracker?

Or you could simply make these modifications and commit.  You're on the 
right track -- your time and effort is appreciated.  We all would like 
to see the release go as smooth as possible.

jason
Permalink | Reply | 7 comments |
headers
Daniel Bondurant | 7 May 2004 08:02

Re: testsite


> Or you could simply make these modifications and commit.  You're on the 
> right track -- your time and effort is appreciated.  We all would like 
> to see the release go as smooth as possible.
> 

I didn't want to do anything because of the code freeze.

also is bc_cms supposed to be working at this point?
I errors when I build it from scratch
Permalink | Reply | 1 comment |
headers
alex black | 7 May 2004 08:10

Re: testsite

>> Or you could simply make these modifications and commit.  You're on the
>> right track -- your time and effort is appreciated.  We all would like
>> to see the release go as smooth as possible.

> I didn't want to do anything because of the code freeze.

Code freeze doesn't apply to testsite. It can be freely developed. Commit
away :)

_a
Permalink | Reply | 0 comments |
headers
alex black | 7 May 2004 10:04

Doc help

http://wiki.binarycloud.com/index.php/Contributor/HomePage

Hi all,

I removed the contributor guide from CVS, because I moved it to the Wiki.

But it's inaccurate as hell.
Any volunteers to have a look? I'm buried in work right now and can't.

Things I noticed:

    -Coding standards are outdated.
    -No mention of docs.binarycloud.com
    -Ancient install instructions

:)

_a
Permalink | Reply | 0 comments |

Gmane