9b50c285b1456b70cf9fb8b448d99c980f52e782
[cordova-docs.git] / README.md
1 # Cordova Docs
2
3 ## Introduction
4
5 This repository contains the source code for the Cordova website. This covers [cordova.io](http://cordova.io) (= [cordova.apache.org](http://cordova.apache.org/)) and its subdomains [docs.cordova.io](http://docs.cordova.io) (= [cordova.apache.org/docs](http://cordova.apache.org/docs)) and [plugins.cordova.io](http://plugins.cordova.io) (= [cordova.apache.org/plugins](http://cordova.apache.org/plugins)).
6
7 ## Table of Contents
8
9   * [Introduction](#introduction)
10   * [Table of Contents](#table-of-contents)
11   * [Installing](#installing)
12   * [Building](#building)
13   * [Developing](#developing)
14     + [Docs Redirects](#docs-redirects)
15   * [Deploying](#deploying)
16   * [Working on the Documentation](#working-on-the-documentation)
17   * [Adding a Tool or a Showcase App](#adding-a-tool-or-a-showcase-app)
18   * [Writing a Blog Post](#writing-a-blog-post)
19   * [Troubleshooting](#troubleshooting)
20   * [Attributions](#attributions)
21
22 ## Installing
23
24 See [doc/installing-a-development-environment.md](doc/installing-a-development-environment.md).
25
26 ## Building
27
28 See [doc/building-the-website.md](doc/building-the-website.md).
29
30 ## Developing
31
32 See [doc/developing-the-website.md](doc/developing-the-website.md).
33
34 ### Docs Redirects
35
36 See [doc/redirects.md](doc/redirects.md).
37
38 ## Deploying
39
40 See [doc/deploying-the-website.md](doc/deploying-the-website.md).
41
42 ## Working on the Documentation
43
44 Refer to [doc/README/en/README.md](doc/README/en/README.md) for information about writing documentation.
45
46 > Note: many changes to the overall documentation come from other repos and are simply pulled together by a build.  tools/bin/fetch_docs.js has more details and www/_data/fetched-files.yml contains an informative list of src/dest pairs.  Most auto-generated files have a comment tag at the top of the file to indicate that they come from elsewhere.
47
48 ## Adding a Tool or a Showcase App
49
50 See [doc/tool-or-showcase.md](doc/tool-or-showcase-app.md).
51
52 ## Writing a Blog Post
53
54 See [doc/blogpost.md](doc/blogpost.md).
55
56 ## Troubleshooting
57
58 See [doc/troubleshooting.md](doc/troubleshooting.md).
59
60 ## Attributions
61
62 For attributions for used open-source work, please see the attributions page: `www/attributions.html`.