You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by Dmitry Blotsky <db...@microsoft.com> on 2015/07/23 07:26:53 UTC
Docs Meeting Notes
Hi folks,
I met with Andrey Kurdyumov yesterday, and we’ve gotten a list of things figured out regarding the docs improvements. Our meeting notes are below:
- Proofreead access for Andrey:
- Viktor Sosa and Lisa DeLuca are the people who can do this
- Merge website and doc repos:
- Will be done in parallel to all other work
- To live in github.com/apache/cordova-docs or in github.com/apache/cordova-website
- Clean up build/deploy process
- Dmitry and Raghav will be working on this
- Manual ToC:
- Agreed that it's needed
- Will make it easier to navigate docs
- Will be in YAML files
- For each set of docs, will use manual ToC or generate automatically if none exists
- Plugin docs:
- Should show on main docs website
- Should be translated with other docs
- Automagic links in docs:
- Should "solidify" autolinking and use manual linking in the future
- Should use fixed header IDs (for #references)
- This allows cross-linking in languages
- This preserves links through heading translation
- CI for docs:
- Not a high priority
- Auto-generation is a nice-to-have
- Content:
- Make it more novice-friendly
- Add more "Getting Started" guides
- Improve content discoverability (see CB-9380 or Stack Overflow)
- Improve visibilty for single platform workflow
- Andrey has some ToC layout ideas; to be addressed in a [DISCUSS]
Kindly,
Dmitry
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
Re: Docs Meeting Notes
Posted by Andrey Kurdumov <ka...@googlemail.com>.
When I mention visibility of the single platform workflow, I mean that
based on SO questions we should optimize for that too, even if we have a
lot of platform oriented docs, these docs not easily navigable.
Cross platform workflow by any way would not be secondary, I personally
concentrate on cross-platform workflow, so docs on that should be improved
too. Maybe it's better create example of TOC to show how I see the whole
docs.
Agree that cross-platform should be highlighted more
2015-07-23 12:13 GMT+06:00 Carlos Santana <cs...@gmail.com>:
> I think it's the opposite the cross platform needs more updates. There are
> not enough details for cross platform. Too many details buried in platform
> centric workflow guides
> On Thu, Jul 23, 2015 at 1:27 AM Dmitry Blotsky <db...@microsoft.com>
> wrote:
>
> > Hi folks,
> >
> > I met with Andrey Kurdyumov yesterday, and we’ve gotten a list of things
> > figured out regarding the docs improvements. Our meeting notes are below:
> >
> > - Proofreead access for Andrey:
> > - Viktor Sosa and Lisa DeLuca are the people who can do this
> >
> > - Merge website and doc repos:
> > - Will be done in parallel to all other work
> > - To live in github.com/apache/cordova-docs or in
> > github.com/apache/cordova-website
> > - Clean up build/deploy process
> > - Dmitry and Raghav will be working on this
> >
> > - Manual ToC:
> > - Agreed that it's needed
> > - Will make it easier to navigate docs
> > - Will be in YAML files
> > - For each set of docs, will use manual ToC or generate automatically
> > if none exists
> >
> > - Plugin docs:
> > - Should show on main docs website
> > - Should be translated with other docs
> >
> > - Automagic links in docs:
> > - Should "solidify" autolinking and use manual linking in the future
> > - Should use fixed header IDs (for #references)
> > - This allows cross-linking in languages
> > - This preserves links through heading translation
> >
> > - CI for docs:
> > - Not a high priority
> > - Auto-generation is a nice-to-have
> >
> > - Content:
> > - Make it more novice-friendly
> > - Add more "Getting Started" guides
> > - Improve content discoverability (see CB-9380 or Stack Overflow)
> > - Improve visibilty for single platform workflow
> > - Andrey has some ToC layout ideas; to be addressed in a [DISCUSS]
> >
> > Kindly,
> > Dmitry
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
> > For additional commands, e-mail: dev-help@cordova.apache.org
> >
>
Re: Docs Meeting Notes
Posted by Carlos Santana <cs...@gmail.com>.
I think it's the opposite the cross platform needs more updates. There are
not enough details for cross platform. Too many details buried in platform
centric workflow guides
On Thu, Jul 23, 2015 at 1:27 AM Dmitry Blotsky <db...@microsoft.com>
wrote:
> Hi folks,
>
> I met with Andrey Kurdyumov yesterday, and we’ve gotten a list of things
> figured out regarding the docs improvements. Our meeting notes are below:
>
> - Proofreead access for Andrey:
> - Viktor Sosa and Lisa DeLuca are the people who can do this
>
> - Merge website and doc repos:
> - Will be done in parallel to all other work
> - To live in github.com/apache/cordova-docs or in
> github.com/apache/cordova-website
> - Clean up build/deploy process
> - Dmitry and Raghav will be working on this
>
> - Manual ToC:
> - Agreed that it's needed
> - Will make it easier to navigate docs
> - Will be in YAML files
> - For each set of docs, will use manual ToC or generate automatically
> if none exists
>
> - Plugin docs:
> - Should show on main docs website
> - Should be translated with other docs
>
> - Automagic links in docs:
> - Should "solidify" autolinking and use manual linking in the future
> - Should use fixed header IDs (for #references)
> - This allows cross-linking in languages
> - This preserves links through heading translation
>
> - CI for docs:
> - Not a high priority
> - Auto-generation is a nice-to-have
>
> - Content:
> - Make it more novice-friendly
> - Add more "Getting Started" guides
> - Improve content discoverability (see CB-9380 or Stack Overflow)
> - Improve visibilty for single platform workflow
> - Andrey has some ToC layout ideas; to be addressed in a [DISCUSS]
>
> Kindly,
> Dmitry
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
> For additional commands, e-mail: dev-help@cordova.apache.org
>