You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by Marcel Kinard <cm...@gmail.com> on 2013/06/12 22:54:31 UTC

Re: [27/46] docs commit: amidst globalization api

Lots of files being touched, but no Jira reference. Mike, in the future could you add a Jira reference to the commit message, per "About Commit Messages" in http://wiki.apache.org/cordova/ContributorWorkflow

After reading for a while, looks like you are a copy editor, and doing some very nice cleanup in the docs, including the new style guide.

-- Marcel Kinard

On Jun 12, 2013, at 1:51 PM, mwbrooks@apache.org wrote:

> amidst globalization api
> 
> 
> Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
> Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/e2d7868b
> Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
> Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
> 
> Branch: refs/heads/master
> Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
> Parents: d9648d0
> Author: Mike Sierra <le...@gmail.com>
> Authored: Fri May 17 09:17:27 2013 -0400
> Committer: Mike Sierra <le...@gmail.com>
> Committed: Fri May 17 09:17:27 2013 -0400
> 
> ----------------------------------------------------------------------
> .../GlobalizationError/globalizationerror.md    | 10 +++---
> .../globalization/globalization.dateToString.md | 33 +++++++++++---------
> .../globalization.getCurrencyPattern.md         | 21 +++++++------
> .../globalization/globalization.getDateNames.md |  6 ++--
> .../globalization.getDatePattern.md             |  6 ++--
> .../globalization.getFirstDayOfWeek.md          |  6 ++--
> .../globalization.getLocaleName.md              |  6 ++--
> .../globalization.getNumberPattern.md           |  6 ++--
> .../globalization.getPreferredLanguage.md       |  6 ++--
> .../globalization.isDayLightSavingsTime.md      |  6 ++--
> .../globalization.numberToString.md             |  6 ++--
> .../globalization/globalization.stringToDate.md |  4 +--
> .../globalization.stringToNumber.md             |  6 ++--
> 13 files changed, 63 insertions(+), 59 deletions(-)
> ----------------------------------------------------------------------

Re: [27/46] docs commit: amidst globalization api

Posted by Michael Brooks <mi...@michaelbrooks.ca>.
The three main points are:

- any features of joDoc [1]
- autolink any text that match a <h1> or <h2>
- automatically replace "x.x.x" pattern with the latest version.

[1] https://github.com/davebalmer/joDoc/wiki


On Fri, Jun 14, 2013 at 5:48 PM, Marcel Kinard <cm...@gmail.com> wrote:

>
> On Jun 13, 2013, at 3:53 PM, Michael Sierra <ms...@adobe.com> wrote:
>
> > Are automatic doc-generation tools doc'ed anywhere?  E.g., the
> conversion of heading text to live links?  Granted it's not intrinsic to
> content, but potentially affects how you might structure it.
>
> Not doc'ed in our repo, that I'm aware of. This is the only thing I've
> been able to find:
> https://github.com/davebalmer/joDoc/wiki
> https://github.com/davebalmer/joDoc/blob/master/TOC.mdown
>
> @mwbrooks, any other hints?
>
> -- Marcel Kinard

Re: [27/46] docs commit: amidst globalization api

Posted by Marcel Kinard <cm...@gmail.com>.
On Jun 13, 2013, at 3:53 PM, Michael Sierra <ms...@adobe.com> wrote:

> Are automatic doc-generation tools doc'ed anywhere?  E.g., the conversion of heading text to live links?  Granted it's not intrinsic to content, but potentially affects how you might structure it.

Not doc'ed in our repo, that I'm aware of. This is the only thing I've been able to find:
https://github.com/davebalmer/joDoc/wiki
https://github.com/davebalmer/joDoc/blob/master/TOC.mdown

@mwbrooks, any other hints?

-- Marcel Kinard

RE: [27/46] docs commit: amidst globalization api

Posted by Michael Sierra <ms...@adobe.com>.
That's already in place, with a reference in the top-level README.md. Thanks.  I'd keep it out of the README, though, as too much info.

Are automatic doc-generation tools doc'ed anywhere?  E.g., the conversion of heading text to live links?  Granted it's not intrinsic to content, but potentially affects how you might structure it.

--Mike Sierra


________________________________________
From: Marcel Kinard [cmarcelk@gmail.com]
Sent: Wednesday, June 12, 2013 5:32 PM
To: dev@cordova.apache.org
Subject: Fwd: [27/46] docs commit: amidst globalization api

Mike, how about adding a reference to STYLESHEET.md in README.md, so people looking at README.md see the great style guidelines you authored? Or perhaps even collapse STYLESHEET.md into README.md so it's all inline in the README.

-- Marcel Kinard

Begin forwarded message:

> From: Marcel Kinard <cm...@gmail.com>
> Subject: Re: [27/46] docs commit: amidst globalization api
> Date: June 12, 2013 4:54:31 PM EDT
> To: "dev@cordova.apache.org" <de...@cordova.apache.org>
>
> Lots of files being touched, but no Jira reference. Mike, in the future could you add a Jira reference to the commit message, per "About Commit Messages" in http://wiki.apache.org/cordova/ContributorWorkflow
>
> After reading for a while, looks like you are a copy editor, and doing some very nice cleanup in the docs, including the new style guide.
>
> -- Marcel Kinard
>
> On Jun 12, 2013, at 1:51 PM, mwbrooks@apache.org wrote:
>
>> amidst globalization api
>>
>>
>> Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
>> Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/e2d7868b
>> Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
>> Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
>>
>> Branch: refs/heads/master
>> Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
>> Parents: d9648d0
>> Author: Mike Sierra <le...@gmail.com>
>> Authored: Fri May 17 09:17:27 2013 -0400
>> Committer: Mike Sierra <le...@gmail.com>
>> Committed: Fri May 17 09:17:27 2013 -0400
>>
>> ----------------------------------------------------------------------
>> .../GlobalizationError/globalizationerror.md    | 10 +++---
>> .../globalization/globalization.dateToString.md | 33 +++++++++++---------
>> .../globalization.getCurrencyPattern.md         | 21 +++++++------
>> .../globalization/globalization.getDateNames.md |  6 ++--
>> .../globalization.getDatePattern.md             |  6 ++--
>> .../globalization.getFirstDayOfWeek.md          |  6 ++--
>> .../globalization.getLocaleName.md              |  6 ++--
>> .../globalization.getNumberPattern.md           |  6 ++--
>> .../globalization.getPreferredLanguage.md       |  6 ++--
>> .../globalization.isDayLightSavingsTime.md      |  6 ++--
>> .../globalization.numberToString.md             |  6 ++--
>> .../globalization/globalization.stringToDate.md |  4 +--
>> .../globalization.stringToNumber.md             |  6 ++--
>> 13 files changed, 63 insertions(+), 59 deletions(-)
>> ----------------------------------------------------------------------
>

Fwd: [27/46] docs commit: amidst globalization api

Posted by Marcel Kinard <cm...@gmail.com>.
Mike, how about adding a reference to STYLESHEET.md in README.md, so people looking at README.md see the great style guidelines you authored? Or perhaps even collapse STYLESHEET.md into README.md so it's all inline in the README.

-- Marcel Kinard

Begin forwarded message:

> From: Marcel Kinard <cm...@gmail.com>
> Subject: Re: [27/46] docs commit: amidst globalization api
> Date: June 12, 2013 4:54:31 PM EDT
> To: "dev@cordova.apache.org" <de...@cordova.apache.org>
> 
> Lots of files being touched, but no Jira reference. Mike, in the future could you add a Jira reference to the commit message, per "About Commit Messages" in http://wiki.apache.org/cordova/ContributorWorkflow
> 
> After reading for a while, looks like you are a copy editor, and doing some very nice cleanup in the docs, including the new style guide.
> 
> -- Marcel Kinard
> 
> On Jun 12, 2013, at 1:51 PM, mwbrooks@apache.org wrote:
> 
>> amidst globalization api
>> 
>> 
>> Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
>> Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/e2d7868b
>> Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
>> Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
>> 
>> Branch: refs/heads/master
>> Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
>> Parents: d9648d0
>> Author: Mike Sierra <le...@gmail.com>
>> Authored: Fri May 17 09:17:27 2013 -0400
>> Committer: Mike Sierra <le...@gmail.com>
>> Committed: Fri May 17 09:17:27 2013 -0400
>> 
>> ----------------------------------------------------------------------
>> .../GlobalizationError/globalizationerror.md    | 10 +++---
>> .../globalization/globalization.dateToString.md | 33 +++++++++++---------
>> .../globalization.getCurrencyPattern.md         | 21 +++++++------
>> .../globalization/globalization.getDateNames.md |  6 ++--
>> .../globalization.getDatePattern.md             |  6 ++--
>> .../globalization.getFirstDayOfWeek.md          |  6 ++--
>> .../globalization.getLocaleName.md              |  6 ++--
>> .../globalization.getNumberPattern.md           |  6 ++--
>> .../globalization.getPreferredLanguage.md       |  6 ++--
>> .../globalization.isDayLightSavingsTime.md      |  6 ++--
>> .../globalization.numberToString.md             |  6 ++--
>> .../globalization/globalization.stringToDate.md |  4 +--
>> .../globalization.stringToNumber.md             |  6 ++--
>> 13 files changed, 63 insertions(+), 59 deletions(-)
>> ----------------------------------------------------------------------
>

RE: [27/46] docs commit: amidst globalization api

Posted by Michael Sierra <ms...@adobe.com>.
Sure, sorry for the volume.  Am working on improving doc, and needed to bring it up to a certain baseline. Will punch in a few JIRAs to clarify plans going forward, and to help organize existing doc bugs.

--Mike Sierra


________________________________________
From: Marcel Kinard [cmarcelk@gmail.com]
Sent: Wednesday, June 12, 2013 4:54 PM
To: dev@cordova.apache.org
Subject: Re: [27/46] docs commit: amidst globalization api

Lots of files being touched, but no Jira reference. Mike, in the future could you add a Jira reference to the commit message, per "About Commit Messages" in http://wiki.apache.org/cordova/ContributorWorkflow

After reading for a while, looks like you are a copy editor, and doing some very nice cleanup in the docs, including the new style guide.

-- Marcel Kinard

On Jun 12, 2013, at 1:51 PM, mwbrooks@apache.org wrote:

> amidst globalization api
>
>
> Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
> Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/e2d7868b
> Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
> Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
>
> Branch: refs/heads/master
> Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
> Parents: d9648d0
> Author: Mike Sierra <le...@gmail.com>
> Authored: Fri May 17 09:17:27 2013 -0400
> Committer: Mike Sierra <le...@gmail.com>
> Committed: Fri May 17 09:17:27 2013 -0400
>
> ----------------------------------------------------------------------
> .../GlobalizationError/globalizationerror.md    | 10 +++---
> .../globalization/globalization.dateToString.md | 33 +++++++++++---------
> .../globalization.getCurrencyPattern.md         | 21 +++++++------
> .../globalization/globalization.getDateNames.md |  6 ++--
> .../globalization.getDatePattern.md             |  6 ++--
> .../globalization.getFirstDayOfWeek.md          |  6 ++--
> .../globalization.getLocaleName.md              |  6 ++--
> .../globalization.getNumberPattern.md           |  6 ++--
> .../globalization.getPreferredLanguage.md       |  6 ++--
> .../globalization.isDayLightSavingsTime.md      |  6 ++--
> .../globalization.numberToString.md             |  6 ++--
> .../globalization/globalization.stringToDate.md |  4 +--
> .../globalization.stringToNumber.md             |  6 ++--
> 13 files changed, 63 insertions(+), 59 deletions(-)
> ----------------------------------------------------------------------