cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dblotsky <...@git.apache.org>
Subject [GitHub] cordova-docs pull request: Adding blog post for docs improvement
Date Thu, 03 Mar 2016 01:11:46 GMT
Github user dblotsky commented on a diff in the pull request:

    https://github.com/apache/cordova-docs/pull/527#discussion_r54822185
  
    --- Diff: www/_posts/2016-02-29-docs-improvement.md ---
    @@ -0,0 +1,39 @@
    +--- 
    +layout: post 
    +author: 
    +    name: Raghav Katyal
    +    url: https://github.com/rakatyal
    +title:  "Significant Documentation Updates"
    +categories: announcements 
    +tags: news releases docs 
    +---
    +
    +We are happy to announce that we have made significant content updates to our documentation.
    +<!--more-->
    +
    +A while back we conducted a [survey](https://apachecordovabot.typeform.com/to/BCc5co)
on the Cordova website asking for feedback on the experience of using Cordova from the developer
standpoint. We received more than 900 responses and documentation emerged as one of the major
pain points for the average Cordova developer.
    +
    +Since then we have made efforts to improve the quality of our documentation. To summarize
it:
    +
    +- Validated and corrected most of the current doc content.
    +- Reorganized our documentation and updated our table of contents to use concise, action-driven
titles for ease of navigation.
    +- Added a 'Reference' section and updated the articles to make them comprehensive and
reader-friendly. The [CLI](http://cordova.apache.org/docs/en/latest/cordova-cli/index.html)
for example, now lives under the 'Reference' section.
    +- Updated the platform guides as single page content following a common structure. For
example, the [Android Guide](http://cordova.apache.org/docs/en/latest/guide/platforms/android/index.html)
and others now have the following sections:
    +	- Requirements and Support
    +	- Installing the Requirements
    +	- Project Configuration
    +	- Debugging
    +	- Signing an App
    +	- Platform Centered Workflow
    +	- Upgrading
    +- Moved Core Plugin docs, like [Cordova Plugin Camera](http://cordova.apache.org/docs/en/latest/cordova-plugin-camera/index.html),
from Github to be a part of the website. They are now accessible from one place and are easier
to read.
    +- Fixed a number of Jira bugs related to documentation as a part of improving these articles.
    --- End diff --
    
    "Jira" -> "JIRA"


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org


Mime
View raw message