Feedback please - what should the new documentation platform be called?

[Colin Clark]

Hi Jonathan,

I think docs-core and docs-template seem like reasonable names. I have one question, though, about how the docs-template will be used in practice.

So, let's say I'm going to use this new reusable Fluidic DocPad infrastructure to create a new documentation site, say for Flocking. You mentioned that I should clone the docs-template repository, and then start customizing it for my site. And then I should "push the changes to a new repository."

What's the typical workflow for taking a git repository, making changes to it, and then committing it all to another repository entirely? Fork-clone-edit? Or something else? Would a user of the docs-template repo want all your history mixed in with theirs? Walk me through the scenario a bit so I understand it fully.

Thanks,

Colin


> On Jul 20, 2015, at 1:14 PM, Jonathan Hung <jhung at ocadu.ca> wrote:
> 
> I'm afraid that "docs-base" could be mis-interpreted as "something to build on top of" which isn't the case. 
> 
> How about: "docs-template" and "docs-core"?
> 
> 
> On Thu, Jul 16, 2015 at 3:32 PM, Cheetham, Anastasia <acheetham at ocadu.ca <mailto:acheetham at ocadu.ca>> wrote:
> 
> On Jul 16, 2015, at 11:28 AM, Jonathan Hung <jhung at ocadu.ca <mailto:jhung at ocadu.ca>> wrote:
> 
>> Looking at the words I'm using to describe these repositories, maybe: 
>> "documentation-skeleton" and "documentation-helpers"
>> "fluid-documentation-core" and "fluid-documentation-helpers" (fluid being the maintainers of the project)
> 
> Here are my impressions; take them for what they’re worth :-)
> 
> I’m not liking the “fluid-“ prefix; the repositories will be part of fluid-project, which is probably sufficient. We don’t have the prefix on any other repositories…
> 
> I also find “documentation-“ a bit long. Could we go with “docs-“ ?
> 
> 
> 
> “skeleton" seems ok (especially if this is similar to something that docpad calls skeleton); another word that comes to mind is “template”
> 
> “helpers” sounds a bit flouncy to me. It could the perceived to be optional. “base” sounds more required, more foundational. 
> 
> -- 
> Anastasia Cheetham – acheetham at ocadu.ca <mailto:acheetham at ocadu.ca>
> Inclusive Design Research Centre
> Inclusive Design Institute
> OCAD University
> 
> 
> 
> 
> -- 
> JONATHAN HUNG
> 
> INCLUSIVE DESIGNER, IDRC
>  
> T: 416 977 6000 x3951 <>
> F: 416 977 9844 <>
> E: jhung at ocadu.ca <mailto:jhung at ocadu.ca>
>  
> OCAD UNIVERSITY
> Inclusive Design Research Centre
> 205 Richmond Street W, Toronto, ON, M5V 1V3
>  
> www.ocadu.ca <http://www.ocadu.ca/>
> www.idrc.ocad.ca <http://www.idrc.ocad.ca/>_______________________________________________________
> fluid-work mailing list - fluid-work at lists.idrc.ocadu.ca <mailto:fluid-work at lists.idrc.ocadu.ca>
> To unsubscribe, change settings or access archives,
> see http://lists.idrc.ocad.ca/mailman/listinfo/fluid-work <http://lists.idrc.ocad.ca/mailman/listinfo/fluid-work>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.idrc.ocad.ca/pipermail/fluid-work/attachments/20150722/43e46b52/attachment.html>