Repository: cordova-docs Updated Branches: refs/heads/master b0c887faa -> 1eff3c6b2
Adding blog post for docs improvement. This closes #527 Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/1eff3c6b Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/1eff3c6b Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/1eff3c6b Branch: refs/heads/master Commit: 1eff3c6b2ac275e1e5857dc067bdc384aa2f65e3 Parents: b0c887f Author: Raghav Katyal <rakat...@microsoft.com> Authored: Tue Mar 1 11:28:02 2016 -0800 Committer: Raghav Katyal <rakat...@microsoft.com> Committed: Thu Mar 3 10:09:59 2016 -0800 ---------------------------------------------------------------------- www/_posts/2016-03-03-docs-improvement.md | 39 ++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/1eff3c6b/www/_posts/2016-03-03-docs-improvement.md ---------------------------------------------------------------------- diff --git a/www/_posts/2016-03-03-docs-improvement.md b/www/_posts/2016-03-03-docs-improvement.md new file mode 100644 index 0000000..76f859b --- /dev/null +++ b/www/_posts/2016-03-03-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. + +These all are reflected in the [latest](http://cordova.apache.org/docs/en/latest/guide/overview/index.html) docs release and we would love to hear your feedback so that we can continue to work on improving it. + +It's easy to provide feedback: + +- [File a JIRA](http://cordova.apache.org/contribute/issues.html) using "Component": Docs. Look at the [Open Issues](https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&mode=hide&jqlQuery=component+%3D+Docs+AND+project+%3D+CB+AND+resolution+%3D+Unresolved+ORDER+BY+priority+DESC) before to make sure the issue doesn't already exist. +- Comment on this blog post using Disqus. +- PRs are welcome. Feel free to submit them using the edit button on the docs pages. + --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@cordova.apache.org For additional commands, e-mail: commits-h...@cordova.apache.org
