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

[Li, Cindy]

Hi Jon,

Another thing that needs to be documented for the content repo (#2) is, the selector “#doc-basec-topics” defined in default.html.handlebars (https://github.com/jhung/doc-base-start/blob/FLUID-5692/src/layouts/default.html.handlebars#L90) should match up with what gets passed into the js component, line 116 in the same file, so clicking the “topics" link can show/hide the side bar.

Cindy

On Jul 16, 2015, at 11:28 AM, Jonathan Hung <jhung at ocadu.ca<mailto:jhung at ocadu.ca>> wrote:

Anastasia,

Cloning is the current method since we don't want the developer to work directly from the Repo #2. Since they're doing their own customizations, it shouldn't be a fork either. The basic workflow is:

1. Clone the starting content (Repo #2)
2. Use node to grab the helpers and dependencies (Repo #1, and other stuff in the package.json file)
3. Customize by overriding, editing, etc.
4. Commit changes to a new repository for their project

I have a more detailed procedure documented in the README here: https://github.com/jhung/doc-base-start/blob/FLUID-5692/README.md

Ideally we would probably want to use a Skeleton for Docpad (which basically does a copy of all the needed files), but we don't have time to investigate how we would do this properly.


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)

Thoughts?

- Jon.

On Wed, Jul 15, 2015 at 11:19 AM, Cheetham, Anastasia <acheetham at ocadu.ca<mailto:acheetham at ocadu.ca>> wrote:

On Jul 15, 2015, at 11:00 AM, Jonathan Hung <jhung at ocadu.ca<mailto:jhung at ocadu.ca>> wrote:

Not sure if that helps.

Yes, it does, thanks.

So when a developer works from a clone of Repository #2

It would help me if you could briefly describe the basic workflow of using these two repositories for one of our websites, and how the content in Repo #2 would be customized. I had assumed that a website (e.g. the fluidproject site, or the infusion docs site, or a new site) would include (in some fashtion) the content in Repo #2 and override it with additional files, but your mention of cloning the repo makes me suspect I might be wrong. That sounds as though a website would be a clone of Repo #2 with the content directly modified.

So how will it work?

--
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

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.idrc.ocad.ca/pipermail/fluid-work/attachments/20150716/fa6f0f39/attachment.html>