List Info

Thread: LiveSupport Docs




LiveSupport Docs
user name
2006-08-11 14:08:42
Is there some reason we dont put the LiveSupport developer docs on the wiki? ; I want to update them as I learn...

- Paul

LiveSupport Docs
user name
2006-08-11 14:37:17
Paul Baranowski wrote:
> Is there some reason we dont put the LiveSupport
developer docs on the 
> wiki?  I want to update them as I learn...
> 
> - Paul

Yes, we want them to be in the source tree, and in the
tarball.  They 
are linked from the wiki (item #5 on the start page).  You
can edit them 
in your local copy; you just need to type 'svn commit'
afterwards.

Ferenc
LiveSupport Docs
user name
2006-08-11 14:48:07
Why do we want them to be in the source tree & tarball?  What kind of developer doesnt have internet access these days? ; I would have agreed with this about 5 years ago, but not these days...is there something I am missing?

- Paul


On 8/11/06, Ferenc Gerlits <gmail.com">fgerlitsgmail.com> wrote:
Paul Baranowski wrote:
>; Is there some reason we dont put the LiveSupport developer docs on the
> wiki? ; I want to update them as I learn...
&gt;
> - Paul

Yes, we want them to be in the source tree, and in the tarball.&nbsp; They
are linked from the wiki (item #5 on the start page).&nbsp; You can edit them
in your local copy; you just need to type 'svn commit' afterwards.

Ferenc

LiveSupport Docs
user name
2006-08-11 15:13:58
Paul Baranowski wrote:
> Why do we want them to be in the source tree &
tarball?  What kind of 
> developer doesnt have internet access these days?  I
would have agreed 
> with this about 5 years ago, but not these days...is
there something I 
> am missing?
> 
> - Paul

You live in the sunnier half (1/100th, really) of the world.
 My 
internet connection is often out for hours, and I imagine
there are 
places with worse connections.

But that's not the point -- what would be the advantage of
converting 
our html documentation into trac-wiki-notation?

Advantage:
  * You don't need to type "svn commit" after
editing the file.

Disadvantages:
  * Html can be viewed with many tools; trac-wiki-markup can
only be 
viewed with trac.
  * A 20-line text edit window is less convenient than your
own text 
editor on your own computer.
  * An html file will be readable and editable basically
forever (in my 
lifetime, for sure).  Trac-wiki-markup may change at any
time.
  * The documentation is separated from the source.
  * If your internet connection is out, you can't read it.
  * It would be a lot of work to convert it.

We have the wiki for outside, possibly computer-illiterate,
people, and 
the source tree for developers.  Looks OK to me; I don't
see the need 
for a change.

Ferenc
LiveSupport Docs
user name
2006-08-16 08:58:25

On 8/11/06, Ferenc Gerlits <gmail.com">fgerlitsgmail.com> wrote:
You live in the sunnier half (1/100th, really) of the world.&nbsp; My
internet connection is often out for hours, and I imagine there are
places with worse connections.

Ah, I always forget about this. ; As for the rest it seems the hybrid system is fine: the wiki for any document that might be edited by a non-developer, and HTML documents for those that are only edited by developers.
 
Paul

[1-5]

about | contact  Other archives ( Real Estate discussion Medical topics )