You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by pu...@apache.org on 2017/03/23 19:16:51 UTC

[3/6] docs commit: Documented that some files are auto-gen from other sources

Documented that some files are auto-gen from other sources


Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/dd12b2b0
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/dd12b2b0
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/dd12b2b0

Branch: refs/heads/master
Commit: dd12b2b0c300261fb70dcb299730102bf4839b9f
Parents: 135d310
Author: Jesse MacFadyen <pu...@gmail.com>
Authored: Wed Mar 22 16:41:09 2017 -0700
Committer: Jesse MacFadyen <pu...@gmail.com>
Committed: Wed Mar 22 16:41:09 2017 -0700

----------------------------------------------------------------------
 .gitignore | 5 +++++
 README.md  | 2 ++
 2 files changed, 7 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/dd12b2b0/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index 7896c17..01d58e9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,6 +9,11 @@ www/_data/all-pages.yml
 www/_data/toc/*-gen.yml
 www/static/css
 www/static/js/plugins.js
+
+# Note if you need to make changes to the following folder, it should be
+# done else where as these files are pulled from other sources
+# see fetch_docs.js for more details.
+# www/_data/fetched-files.yml contains an informative list of src/dest pairs
 www/docs/*/dev/reference
 
 node_modules

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/dd12b2b0/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 718f79d..578fc1c 100644
--- a/README.md
+++ b/README.md
@@ -236,6 +236,8 @@ Working on the Documentation
 
 Refer to this [README.md](doc/README/en/README.md) for information about writing documentation.
 
+> 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.
+
 Adding a Tool or a Showcase App
 ===============================
 


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