You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by Becky Gibson <gi...@gmail.com> on 2012/10/08 21:06:32 UTC

Documenting settings

I was trying to fix CB-1515 (https://issues.apache.org/jira/browse/CB-1515)
to document the new iOS pList settings.  Since md files can be tricky I
wanted to build the file with my changes and verify my additions.  However,
I can't find where this file,
[incubator-cordova-ios.git]<https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;hb=HEAD>
 / guides<https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;f=guides;hb=HEAD>
 / Cordova Settings
File.md<https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=blob_plain;f=guides/Cordova+Settings+File.md;hb=HEAD>
is
used?  I don't find it in the Docs repo although other iOS Guide files are
included in docus.

Should this be included in Docs? Where? Are there other platforms that have
settings files that need to be documented?

thanks,
-becky

Re: Documenting settings

Posted by Shazron <sh...@gmail.com>.
Hmm, I just tried it out and it worked - showed a clickable entry in
the TOC? Not sure why it didn't for you. I just basically copied the
guide/cordova-webview folder and renamed and copied bunch of stuff.

On Tue, Oct 9, 2012 at 1:58 PM, Becky Gibson <gi...@gmail.com> wrote:
> Yeah, tried that but didn't magically get a new "Projects Settings" entry
> in the left hand side navigation nor a link in the Guides section.  I
> really would prefer not to learn ruby in order to grok all of the build
> scripts :-)
>
>
> On Tue, Oct 9, 2012 at 4:51 PM, Shazron <sh...@gmail.com> wrote:
>
>> I believe... it is matched on the document title in the index.md
>> subfolders. So in the main index.md, add your li/h2 tag with your
>> title. Then in a subfolder (say in guides/foo), have an index.md in
>> that, with the main title the same as the one in your li/h2 tag.
>>
>> On Tue, Oct 9, 2012 at 1:13 PM, Becky Gibson <gi...@gmail.com>
>> wrote:
>> > Can someone tell me the magic to generate the front docs page?  I need to
>> > add a new Guide and can't quickly see how it is generated.
>> > thanks,
>> > -becky
>> >
>> >
>> > On Tue, Oct 9, 2012 at 3:42 PM, Shazron <sh...@gmail.com> wrote:
>> >
>> >> We really should put that guide into the docs repo and remove the
>> >> existing one in the iOS repo. At least that's what I've been doing
>> >> when a guide has been graduated to the docs repo.
>> >>
>> >> On Tue, Oct 9, 2012 at 12:37 PM, Becky Gibson <gi...@gmail.com>
>> >> wrote:
>> >> > Another docs question.  In iOS  we seem to keep the guides in two
>> places.
>> >> >  There is incubator-cordova-ios/guides and
>> >> > incubator-cordova-docs/docs/en/edge/guides.   Should I be committing
>> to
>> >> > both locations or is there some build process that copies from the
>> >> platform
>> >> > dir into the docs/guides dir?  I'm guessing we commit in two locations
>> >> but
>> >> > wanted to double check first.
>> >> >
>> >> > thanks,
>> >> > -becky
>> >> >
>> >> > On Tue, Oct 9, 2012 at 12:04 PM, Michael Brooks <
>> >> michael@michaelbrooks.ca>wrote:
>> >> >
>> >> >> Hi Becky,
>> >> >>
>> >> >> I think it's okay to include platform settings in Apache Cordova's
>> core
>> >> >> documentation. As far as I know, iOS is the only platform that has
>> it's
>> >> own
>> >> >> custom settings. However, most platforms have vendor settings that
>> our
>> >> >> users likely hunt down themselves. For BlackBerry, a reference to
>> >> WebWorks
>> >> >> JavaScript API can be include. For Android, a reference to Android's
>> >> >> manifest documentation can be included.
>> >> >>
>> >> >> I'd suggest a link on the homepage called "Project Settings" and
>> >> sub-pages
>> >> >> for each platform.
>> >> >>
>> >> >> Michael
>> >> >>
>> >> >> On Mon, Oct 8, 2012 at 12:06 PM, Becky Gibson <
>> gibson.becky@gmail.com
>> >> >> >wrote:
>> >> >>
>> >> >> > I was trying to fix CB-1515 (
>> >> >> https://issues.apache.org/jira/browse/CB-1515
>> >> >> > )
>> >> >> > to document the new iOS pList settings.  Since md files can be
>> tricky
>> >> I
>> >> >> > wanted to build the file with my changes and verify my additions.
>> >> >>  However,
>> >> >> > I can't find where this file,
>> >> >> > [incubator-cordova-ios.git]<
>> >> >> >
>> >> >>
>> >>
>> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;hb=HEAD
>> >> >> > >
>> >> >> >  / guides<
>> >> >> >
>> >> >>
>> >>
>> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;f=guides;hb=HEAD
>> >> >> > >
>> >> >> >  / Cordova Settings
>> >> >> > File.md<
>> >> >> >
>> >> >>
>> >>
>> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=blob_plain;f=guides/Cordova+Settings+File.md;hb=HEAD
>> >> >> > >
>> >> >> > is
>> >> >> > used?  I don't find it in the Docs repo although other iOS Guide
>> files
>> >> >> are
>> >> >> > included in docus.
>> >> >> >
>> >> >> > Should this be included in Docs? Where? Are there other platforms
>> that
>> >> >> have
>> >> >> > settings files that need to be documented?
>> >> >> >
>> >> >> > thanks,
>> >> >> > -becky
>> >> >> >
>> >> >>
>> >>
>>

Re: Documenting settings

Posted by Becky Gibson <gi...@gmail.com>.
Yeah, tried that but didn't magically get a new "Projects Settings" entry
in the left hand side navigation nor a link in the Guides section.  I
really would prefer not to learn ruby in order to grok all of the build
scripts :-)


On Tue, Oct 9, 2012 at 4:51 PM, Shazron <sh...@gmail.com> wrote:

> I believe... it is matched on the document title in the index.md
> subfolders. So in the main index.md, add your li/h2 tag with your
> title. Then in a subfolder (say in guides/foo), have an index.md in
> that, with the main title the same as the one in your li/h2 tag.
>
> On Tue, Oct 9, 2012 at 1:13 PM, Becky Gibson <gi...@gmail.com>
> wrote:
> > Can someone tell me the magic to generate the front docs page?  I need to
> > add a new Guide and can't quickly see how it is generated.
> > thanks,
> > -becky
> >
> >
> > On Tue, Oct 9, 2012 at 3:42 PM, Shazron <sh...@gmail.com> wrote:
> >
> >> We really should put that guide into the docs repo and remove the
> >> existing one in the iOS repo. At least that's what I've been doing
> >> when a guide has been graduated to the docs repo.
> >>
> >> On Tue, Oct 9, 2012 at 12:37 PM, Becky Gibson <gi...@gmail.com>
> >> wrote:
> >> > Another docs question.  In iOS  we seem to keep the guides in two
> places.
> >> >  There is incubator-cordova-ios/guides and
> >> > incubator-cordova-docs/docs/en/edge/guides.   Should I be committing
> to
> >> > both locations or is there some build process that copies from the
> >> platform
> >> > dir into the docs/guides dir?  I'm guessing we commit in two locations
> >> but
> >> > wanted to double check first.
> >> >
> >> > thanks,
> >> > -becky
> >> >
> >> > On Tue, Oct 9, 2012 at 12:04 PM, Michael Brooks <
> >> michael@michaelbrooks.ca>wrote:
> >> >
> >> >> Hi Becky,
> >> >>
> >> >> I think it's okay to include platform settings in Apache Cordova's
> core
> >> >> documentation. As far as I know, iOS is the only platform that has
> it's
> >> own
> >> >> custom settings. However, most platforms have vendor settings that
> our
> >> >> users likely hunt down themselves. For BlackBerry, a reference to
> >> WebWorks
> >> >> JavaScript API can be include. For Android, a reference to Android's
> >> >> manifest documentation can be included.
> >> >>
> >> >> I'd suggest a link on the homepage called "Project Settings" and
> >> sub-pages
> >> >> for each platform.
> >> >>
> >> >> Michael
> >> >>
> >> >> On Mon, Oct 8, 2012 at 12:06 PM, Becky Gibson <
> gibson.becky@gmail.com
> >> >> >wrote:
> >> >>
> >> >> > I was trying to fix CB-1515 (
> >> >> https://issues.apache.org/jira/browse/CB-1515
> >> >> > )
> >> >> > to document the new iOS pList settings.  Since md files can be
> tricky
> >> I
> >> >> > wanted to build the file with my changes and verify my additions.
> >> >>  However,
> >> >> > I can't find where this file,
> >> >> > [incubator-cordova-ios.git]<
> >> >> >
> >> >>
> >>
> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;hb=HEAD
> >> >> > >
> >> >> >  / guides<
> >> >> >
> >> >>
> >>
> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;f=guides;hb=HEAD
> >> >> > >
> >> >> >  / Cordova Settings
> >> >> > File.md<
> >> >> >
> >> >>
> >>
> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=blob_plain;f=guides/Cordova+Settings+File.md;hb=HEAD
> >> >> > >
> >> >> > is
> >> >> > used?  I don't find it in the Docs repo although other iOS Guide
> files
> >> >> are
> >> >> > included in docus.
> >> >> >
> >> >> > Should this be included in Docs? Where? Are there other platforms
> that
> >> >> have
> >> >> > settings files that need to be documented?
> >> >> >
> >> >> > thanks,
> >> >> > -becky
> >> >> >
> >> >>
> >>
>

Re: Documenting settings

Posted by Shazron <sh...@gmail.com>.
I believe... it is matched on the document title in the index.md
subfolders. So in the main index.md, add your li/h2 tag with your
title. Then in a subfolder (say in guides/foo), have an index.md in
that, with the main title the same as the one in your li/h2 tag.

On Tue, Oct 9, 2012 at 1:13 PM, Becky Gibson <gi...@gmail.com> wrote:
> Can someone tell me the magic to generate the front docs page?  I need to
> add a new Guide and can't quickly see how it is generated.
> thanks,
> -becky
>
>
> On Tue, Oct 9, 2012 at 3:42 PM, Shazron <sh...@gmail.com> wrote:
>
>> We really should put that guide into the docs repo and remove the
>> existing one in the iOS repo. At least that's what I've been doing
>> when a guide has been graduated to the docs repo.
>>
>> On Tue, Oct 9, 2012 at 12:37 PM, Becky Gibson <gi...@gmail.com>
>> wrote:
>> > Another docs question.  In iOS  we seem to keep the guides in two places.
>> >  There is incubator-cordova-ios/guides and
>> > incubator-cordova-docs/docs/en/edge/guides.   Should I be committing to
>> > both locations or is there some build process that copies from the
>> platform
>> > dir into the docs/guides dir?  I'm guessing we commit in two locations
>> but
>> > wanted to double check first.
>> >
>> > thanks,
>> > -becky
>> >
>> > On Tue, Oct 9, 2012 at 12:04 PM, Michael Brooks <
>> michael@michaelbrooks.ca>wrote:
>> >
>> >> Hi Becky,
>> >>
>> >> I think it's okay to include platform settings in Apache Cordova's core
>> >> documentation. As far as I know, iOS is the only platform that has it's
>> own
>> >> custom settings. However, most platforms have vendor settings that our
>> >> users likely hunt down themselves. For BlackBerry, a reference to
>> WebWorks
>> >> JavaScript API can be include. For Android, a reference to Android's
>> >> manifest documentation can be included.
>> >>
>> >> I'd suggest a link on the homepage called "Project Settings" and
>> sub-pages
>> >> for each platform.
>> >>
>> >> Michael
>> >>
>> >> On Mon, Oct 8, 2012 at 12:06 PM, Becky Gibson <gibson.becky@gmail.com
>> >> >wrote:
>> >>
>> >> > I was trying to fix CB-1515 (
>> >> https://issues.apache.org/jira/browse/CB-1515
>> >> > )
>> >> > to document the new iOS pList settings.  Since md files can be tricky
>> I
>> >> > wanted to build the file with my changes and verify my additions.
>> >>  However,
>> >> > I can't find where this file,
>> >> > [incubator-cordova-ios.git]<
>> >> >
>> >>
>> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;hb=HEAD
>> >> > >
>> >> >  / guides<
>> >> >
>> >>
>> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;f=guides;hb=HEAD
>> >> > >
>> >> >  / Cordova Settings
>> >> > File.md<
>> >> >
>> >>
>> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=blob_plain;f=guides/Cordova+Settings+File.md;hb=HEAD
>> >> > >
>> >> > is
>> >> > used?  I don't find it in the Docs repo although other iOS Guide files
>> >> are
>> >> > included in docus.
>> >> >
>> >> > Should this be included in Docs? Where? Are there other platforms that
>> >> have
>> >> > settings files that need to be documented?
>> >> >
>> >> > thanks,
>> >> > -becky
>> >> >
>> >>
>>

Re: Documenting settings

Posted by Becky Gibson <gi...@gmail.com>.
Can someone tell me the magic to generate the front docs page?  I need to
add a new Guide and can't quickly see how it is generated.
thanks,
-becky


On Tue, Oct 9, 2012 at 3:42 PM, Shazron <sh...@gmail.com> wrote:

> We really should put that guide into the docs repo and remove the
> existing one in the iOS repo. At least that's what I've been doing
> when a guide has been graduated to the docs repo.
>
> On Tue, Oct 9, 2012 at 12:37 PM, Becky Gibson <gi...@gmail.com>
> wrote:
> > Another docs question.  In iOS  we seem to keep the guides in two places.
> >  There is incubator-cordova-ios/guides and
> > incubator-cordova-docs/docs/en/edge/guides.   Should I be committing to
> > both locations or is there some build process that copies from the
> platform
> > dir into the docs/guides dir?  I'm guessing we commit in two locations
> but
> > wanted to double check first.
> >
> > thanks,
> > -becky
> >
> > On Tue, Oct 9, 2012 at 12:04 PM, Michael Brooks <
> michael@michaelbrooks.ca>wrote:
> >
> >> Hi Becky,
> >>
> >> I think it's okay to include platform settings in Apache Cordova's core
> >> documentation. As far as I know, iOS is the only platform that has it's
> own
> >> custom settings. However, most platforms have vendor settings that our
> >> users likely hunt down themselves. For BlackBerry, a reference to
> WebWorks
> >> JavaScript API can be include. For Android, a reference to Android's
> >> manifest documentation can be included.
> >>
> >> I'd suggest a link on the homepage called "Project Settings" and
> sub-pages
> >> for each platform.
> >>
> >> Michael
> >>
> >> On Mon, Oct 8, 2012 at 12:06 PM, Becky Gibson <gibson.becky@gmail.com
> >> >wrote:
> >>
> >> > I was trying to fix CB-1515 (
> >> https://issues.apache.org/jira/browse/CB-1515
> >> > )
> >> > to document the new iOS pList settings.  Since md files can be tricky
> I
> >> > wanted to build the file with my changes and verify my additions.
> >>  However,
> >> > I can't find where this file,
> >> > [incubator-cordova-ios.git]<
> >> >
> >>
> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;hb=HEAD
> >> > >
> >> >  / guides<
> >> >
> >>
> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;f=guides;hb=HEAD
> >> > >
> >> >  / Cordova Settings
> >> > File.md<
> >> >
> >>
> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=blob_plain;f=guides/Cordova+Settings+File.md;hb=HEAD
> >> > >
> >> > is
> >> > used?  I don't find it in the Docs repo although other iOS Guide files
> >> are
> >> > included in docus.
> >> >
> >> > Should this be included in Docs? Where? Are there other platforms that
> >> have
> >> > settings files that need to be documented?
> >> >
> >> > thanks,
> >> > -becky
> >> >
> >>
>

Re: Documenting settings

Posted by Shazron <sh...@gmail.com>.
We really should put that guide into the docs repo and remove the
existing one in the iOS repo. At least that's what I've been doing
when a guide has been graduated to the docs repo.

On Tue, Oct 9, 2012 at 12:37 PM, Becky Gibson <gi...@gmail.com> wrote:
> Another docs question.  In iOS  we seem to keep the guides in two places.
>  There is incubator-cordova-ios/guides and
> incubator-cordova-docs/docs/en/edge/guides.   Should I be committing to
> both locations or is there some build process that copies from the platform
> dir into the docs/guides dir?  I'm guessing we commit in two locations but
> wanted to double check first.
>
> thanks,
> -becky
>
> On Tue, Oct 9, 2012 at 12:04 PM, Michael Brooks <mi...@michaelbrooks.ca>wrote:
>
>> Hi Becky,
>>
>> I think it's okay to include platform settings in Apache Cordova's core
>> documentation. As far as I know, iOS is the only platform that has it's own
>> custom settings. However, most platforms have vendor settings that our
>> users likely hunt down themselves. For BlackBerry, a reference to WebWorks
>> JavaScript API can be include. For Android, a reference to Android's
>> manifest documentation can be included.
>>
>> I'd suggest a link on the homepage called "Project Settings" and sub-pages
>> for each platform.
>>
>> Michael
>>
>> On Mon, Oct 8, 2012 at 12:06 PM, Becky Gibson <gibson.becky@gmail.com
>> >wrote:
>>
>> > I was trying to fix CB-1515 (
>> https://issues.apache.org/jira/browse/CB-1515
>> > )
>> > to document the new iOS pList settings.  Since md files can be tricky I
>> > wanted to build the file with my changes and verify my additions.
>>  However,
>> > I can't find where this file,
>> > [incubator-cordova-ios.git]<
>> >
>> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;hb=HEAD
>> > >
>> >  / guides<
>> >
>> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;f=guides;hb=HEAD
>> > >
>> >  / Cordova Settings
>> > File.md<
>> >
>> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=blob_plain;f=guides/Cordova+Settings+File.md;hb=HEAD
>> > >
>> > is
>> > used?  I don't find it in the Docs repo although other iOS Guide files
>> are
>> > included in docus.
>> >
>> > Should this be included in Docs? Where? Are there other platforms that
>> have
>> > settings files that need to be documented?
>> >
>> > thanks,
>> > -becky
>> >
>>

Re: Documenting settings

Posted by Becky Gibson <gi...@gmail.com>.
Another docs question.  In iOS  we seem to keep the guides in two places.
 There is incubator-cordova-ios/guides and
incubator-cordova-docs/docs/en/edge/guides.   Should I be committing to
both locations or is there some build process that copies from the platform
dir into the docs/guides dir?  I'm guessing we commit in two locations but
wanted to double check first.

thanks,
-becky

On Tue, Oct 9, 2012 at 12:04 PM, Michael Brooks <mi...@michaelbrooks.ca>wrote:

> Hi Becky,
>
> I think it's okay to include platform settings in Apache Cordova's core
> documentation. As far as I know, iOS is the only platform that has it's own
> custom settings. However, most platforms have vendor settings that our
> users likely hunt down themselves. For BlackBerry, a reference to WebWorks
> JavaScript API can be include. For Android, a reference to Android's
> manifest documentation can be included.
>
> I'd suggest a link on the homepage called "Project Settings" and sub-pages
> for each platform.
>
> Michael
>
> On Mon, Oct 8, 2012 at 12:06 PM, Becky Gibson <gibson.becky@gmail.com
> >wrote:
>
> > I was trying to fix CB-1515 (
> https://issues.apache.org/jira/browse/CB-1515
> > )
> > to document the new iOS pList settings.  Since md files can be tricky I
> > wanted to build the file with my changes and verify my additions.
>  However,
> > I can't find where this file,
> > [incubator-cordova-ios.git]<
> >
> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;hb=HEAD
> > >
> >  / guides<
> >
> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;f=guides;hb=HEAD
> > >
> >  / Cordova Settings
> > File.md<
> >
> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=blob_plain;f=guides/Cordova+Settings+File.md;hb=HEAD
> > >
> > is
> > used?  I don't find it in the Docs repo although other iOS Guide files
> are
> > included in docus.
> >
> > Should this be included in Docs? Where? Are there other platforms that
> have
> > settings files that need to be documented?
> >
> > thanks,
> > -becky
> >
>

Re: Documenting settings

Posted by Michael Brooks <mi...@michaelbrooks.ca>.
Hi Becky,

I think it's okay to include platform settings in Apache Cordova's core
documentation. As far as I know, iOS is the only platform that has it's own
custom settings. However, most platforms have vendor settings that our
users likely hunt down themselves. For BlackBerry, a reference to WebWorks
JavaScript API can be include. For Android, a reference to Android's
manifest documentation can be included.

I'd suggest a link on the homepage called "Project Settings" and sub-pages
for each platform.

Michael

On Mon, Oct 8, 2012 at 12:06 PM, Becky Gibson <gi...@gmail.com>wrote:

> I was trying to fix CB-1515 (https://issues.apache.org/jira/browse/CB-1515
> )
> to document the new iOS pList settings.  Since md files can be tricky I
> wanted to build the file with my changes and verify my additions.  However,
> I can't find where this file,
> [incubator-cordova-ios.git]<
> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;hb=HEAD
> >
>  / guides<
> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=tree;f=guides;hb=HEAD
> >
>  / Cordova Settings
> File.md<
> https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-ios.git;a=blob_plain;f=guides/Cordova+Settings+File.md;hb=HEAD
> >
> is
> used?  I don't find it in the Docs repo although other iOS Guide files are
> included in docus.
>
> Should this be included in Docs? Where? Are there other platforms that have
> settings files that need to be documented?
>
> thanks,
> -becky
>