RE: [DISCUSS] New Information Architecture for Cordova Website

[Raghav Katyal <ra...@microsoft.com>]

Hi everyone!

Thanks for all the comments and inputs. I have incorporated them in the proposal and created Jira tasks to go ahead with the changes. You can find them here:
https://issues.apache.org/jira/browse/CB-10354?jql=labels%20%3D%20Docs-6.x

If anyone wants to help out, please feel free to assign any of the tasks to yourself. I have added the changes we felt needed in the description of the tasks and also general guidelines for overall content of the articles.

-Raghav

-----Original Message-----
From: Andrey Kurdumov [mailto:kant2002@googlemail.com] 
Sent: Friday, December 11, 2015 11:20 AM
To: dev@cordova.apache.org
Subject: Re: [DISCUSS] New Information Architecture for Cordova Website

I add comments on the docs structure to PR with notes why I think it that way. This is based on my personal struggling with finding something on docs, and other dumb questions which people asking on SO.

2015-12-11 20:40 GMT+06:00 Carlos Santana <cs...@gmail.com>:

> yes I agree Reference your be top level at TOC, I left other comments 
> in the PR
>
> On Thu, Dec 10, 2015 at 3:28 PM Dmitry Blotsky 
> <db...@microsoft.com>
> wrote:
>
> > Hey folks,
> >
> > Please take a look at the PR discussing this proposal:
> > https://github.com/cordova/cordova-discuss/pull/31.
> >
> > Personally, I’d like to solicit opinions on having the Reference 
> > section be a top-level title outside of the specific use cases.
> >
> > Kindly,
> > Dmitry
> >
> > On Dec 7, 2015, at 3:24 PM, Raghav Katyal <rakatyal@microsoft.com
> <mailto:
> > rakatyal@microsoft.com>> wrote:
> >
> > Looks like something is messing up with the formatting. Kindly refer 
> > to the discuss PR in the mail.
> >
> > -Raghav
> >
> > From: Raghav Katyal
> > Sent: Monday, December 7, 2015 3:19 PM
> > To: 'dev@cordova.apache.org<ma...@cordova.apache.org>' < 
> > dev@cordova.apache.org<ma...@cordova.apache.org>>
> > Subject: [DISCUSS] New Information Architecture for Cordova Website
> >
> > Hi everyone!
> >
> > As a part of the task of improving the Cordova documentation, we 
> > came up with a new Information Architecture for the website. The 
> > current architecture was not very comprehensive and lacked a 
> > well-defined
> structure
> > which made the documentation difficult to follow and find for people.
> Also
> > we decided to add some new content based on the customer feedback 
> > from
> our
> > website survey.
> >
> > New articles to be added:
> >
> > Debug and Test (for both apps and plugins) Publish (app to the 
> > appstore for all platforms) Automate Tasks (tips to use tools like 
> > grunt, gulp and uglify with
> Cordova)
> > Register with NPM
> > Sample Apps (section containing some sample apps built on Cordova)
> >
> > This is the proposed new IA:
> >
> >
> > ·         Overview
> >
> > ·         Create apps
> >
> > o    Create your first app
> >
> > o    Develop for platforms
> >
> > o    Manage versions and platforms
> >
> > o    Debug and test
> >
> > o    Automate Tasks
> >
> > o    Store data
> >
> > o    Manage privacy
> >
> > o    Manage security
> >
> > o    Whitelisting
> >
> > o    Publish
> >
> > o    Reference
> >
> > §  Config.xml
> >
> > §  Events
> >
> > §  Plugins
> >
> > §  CLI
> >
> > §  Hooks
> >
> > ·         Create plugins
> >
> > o    Create a plugin
> >
> > o    Register with NPM
> >
> > o    Develop for platforms
> >
> > o    Use Plugman
> >
> > o    Debug and test
> >
> > o    Reference
> >
> > §  Plugin.xml
> >
> > ·         Embed Cordova in native apps
> >
> > ·         Sample Apps
> >
> >
> >
> > We also did a document scrub and tried to figure out the articles 
> > which need to be modified or updated with the current information 
> > and plan to work on them. Some of these needs to be converted into 
> > proper reference
> as
> > seen in the IA.
> >
> > Here is the discuss proposal:
> >
> > https://github.com/cordova/cordova-discuss/pull/31
> >
> > Please give feedback or let us know if you would like to help with 
> > this task.
> >
> > -Raghav
> >
> >
> >
>