No - I'm saying to embed them.  Let me explain.

We've created a system that consolidates all the docs into a consistent place 
and breaks them into manageable parts.  We're maintaining all of the docs in 
that way.  That seems like a very good thing to me.

We've create a way to export all of the docs into single books to be used 
outside of the UI and github.  That seems like a very good thing to me.

We've got a way to link content sections back to github so readers can easily 
find where to make corrections.  That also seems like a good thing.

Since we've got all the content in the UI, I don't see why we should omit a 
link to it.  Filtering it out is more effort.

-----Original Message-----
From: Kenneth Wimer [mailto:wi...@suse.de] 
Sent: Wednesday, March 27, 2013 1:58 PM
To: Hirschfeld, Rob
Cc: ja...@suse.de; crowbar
Subject: Re: [Crowbar] System Documentation UI

On 3/27/13 7:29 PM, rob_hirschf...@dell.com wrote:
> +1
>
> Where would you see the developer docs link?
Typically, I would expect the developer docs to be on the wiki in github. I 
have nothing against showing them in the System Documentation in development 
mode but a) it seems like the last place I would look for such information and 
b) when the crowbar ui is broken (and therefor needs development) the docs are 
also down.

To reiterate, I would leave the user-based docs in the git repo directly and 
put the developer docs on the github wiki. Just my two cents :-)

--
Kenneth Wimer

> -----Original Message-----
> From: crowbar-bounces On Behalf Of Kenneth Wimer
> Sent: Wednesday, March 27, 2013 10:49 AM
> To: James Tan
> Cc: crowbar
> Subject: Re: [Crowbar] System Documentation UI
>
> On 3/27/13 3:49 PM, James Tan wrote:
>> On 03/27/2013 03:02 PM, Kenneth Wimer wrote:
>>> I noticed the typos already and fixed them in the SVG file. BTW, I 
>>> made all of this with inkscape so if someone is interested in the 
>>> source files I'll put them in the repo as well.
>> Sweet. Yes why not just push the .svg in - I think most modern 
>> browsers can render that directly?
> Most browsers can do svg but not inkscape svg. I have each wireframe on a 
> different layer and the notes for each again on a different layer. I imagine 
> it will look pretty messed up in a browser.
>
> I am about to push the corrections to the images and the source svg.
>
> --
> Kenneth Wimer
>    
> SUSE LINUX Products GmbH, GF: Jeff Hawn, Jennifer Guild, Felix 
> Imendörffer, HRB 16746 (AG Nürnberg) Maxfeldstraße 5, 90409 Nürnberg, 
> Germany
>
> _______________________________________________
> Crowbar mailing list
> Crowbar@dell.com
> https://lists.us.dell.com/mailman/listinfo/crowbar
> For more information: http://crowbar.github.com/


--
Kenneth Wimer
  
SUSE LINUX Products GmbH, GF: Jeff Hawn, Jennifer Guild, Felix Imendörffer, HRB 
16746 (AG Nürnberg) Maxfeldstraße 5, 90409 Nürnberg, Germany

_______________________________________________
Crowbar mailing list
Crowbar@dell.com
https://lists.us.dell.com/mailman/listinfo/crowbar
For more information: http://crowbar.github.com/

Reply via email to