Meeting to discuss deploying versioned Infusion Docs

[Justin Obara]

Hey everyone,

We’ve captured the meeting notes in gpii-pad
<https://pad.gpii.net/p/infusion-docs-2017-02-09-wwf4ndx>, but I’ve copied
them below as well.

Thanks
Justin


Meeting 2017/02/09 to discuss deploying versioned documentation for Infusion

Present: Alan, Antranig, Dana, Giovanni, Jonathan, Joseph, Justin, Simon,
Tony

We have decided to move away from our implementation based on docpad
plugins and github pages.
We will instead run some kind of CI task which automatically monitors all
branches and tags in the infusion-docs repository, and runs the docpad task
WITHIN each branch to generate one directory per branch/tag
We don't particularly trust either docpad or Jenkins plugins - the initial
implementation should just use a basic technology such as shell
scripts/Python/Grunt etc.

WHAT WE WANT
    - deploy documentation for all branches and tags
    - low friction, probably simple enough to roll our own with Grunt or
shell script rather than using plugins
    - initially, a very simple index page like the following:
https://nodejs.org/docs/
    - in time, a properly styled (and UIO-enabled) landing page like the
following: https://nodejs.org/en/docs/
    - the Python docs are an example with a menu to select between versions
using a drop-down: https://docs.python.org/3/

CURRENT URL: http://docs.fluidproject.org/infusion/development/

DESIRED URL STATE:
http://docs.fluidproject.org/infusion/development
http://docs.fluidproject.org/infusion/v.2.0.0 <-- many of these older tags
are misnamed. We should retag using a standard scheme where the tag name is
simply the "version" field from package.json of the corresponding version
of Infusion
http://docs.fluidproject.org/infusion/v.1.5.0

SAMPLE STRUCTURE
- /development - master
- /v2.0.0 - from v2.0.0 tag
- /v1.5.0 - from v1.5.0 tag

Noone particularly has time to work on this. Gio says if someone can work
on the build scripts, he will find it easy to implement the CI for this
ALAN will spike something that generates a build for each branch and tag
- 1) MAKE JSON FILE OF BRANCHES AND TAGS
- 2) FEED TO A THING
- 3) MAKE A DIRECTORY STRUCTURE
- 4) PUT STUFF IN THAT DIRECTORY STRUCTURE
- 5) ?!?!??
- 6) PROFIT
ADTKINS will write a "version picker" - "2nd nail in the coffin"
A "spike quality solution" will be fine
My spikes have tests (at least the good ones do).

On February 7, 2017 at 7:23:48 AM, Justin Obara (obara.justin at gmail.com)
wrote:

Thanks Tony,

Yes, that’s correct.

Thanks
Justin


On February 7, 2017 at 4:34:31 AM, Tony Atkins (tony at raisingthefloor.org)
wrote:

Thanks, Justin.

Just to be clear, it's *this Thursday* at 10-11 ET.

Cheers,


Tony

On Mon, Feb 6, 2017 at 8:45 PM, Justin Obara <obara.justin at gmail.com> wrote:

> The meeting is scheduled for 10 - 11am ET. We can sync up in the
> fluid-work channel before hand and meet in one of our vidyo rooms.
>
> Thanks
> Justin
>
>
> On February 3, 2017 at 7:32:49 AM, Justin Obara (obara.justin at gmail.com)
> wrote:
>
>
>
> Hello everyone,
>
> Now that Infusion 2.0 has been officially announced, we should discuss how
> and where we will deploy multiple versions of the Infusion Documentation.
> Currently we only deploy the development docs
> <http://docs.fluidproject.org/infusion/development/>  but would like to
> deploy documentation for stable releases as well.
>
> I’ve created a Doodle Poll <http://doodle.com/poll/dm4rmrv6we3die2u> to
> arrange for the meeting. Please fill out the times you are available to
> join. It should be adjusted to your local time zone.
>
> Thanks
> Justin
>
>
> _______________________________________________________
> fluid-work mailing list - fluid-work at lists.idrc.ocad.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/20170209/19c78b39/attachment.html>