You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by sarangan12 <gi...@git.apache.org> on 2016/02/09 03:12:40 UTC
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
GitHub user sarangan12 opened a pull request:
https://github.com/apache/cordova-docs/pull/493
CB-10552: Pull all the plugin docs to Cordova
Pulling plugin docs to cordova
@dblotsky Can you take a look at this PR?
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/sarangan12/cordova-docs CB-10552
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/cordova-docs/pull/493.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #493
----
commit 9740f919797abc64c2b98c2ccb69796c09756c56
Author: Sarangan Rajamanickam <sa...@microsoft.com>
Date: 2016-02-06T01:33:57Z
CB-10552: Pull all the plugin docs to Cordova
Pulling plugin docs to cordova
----
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/493#discussion_r52689249
--- Diff: tools/bin/fetch_docs.js ---
@@ -0,0 +1,144 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+"use strict";
+
+var fs = require("fs");
+var fse = require("fs-extra");
+var https = require("https");
+var path = require("path");
+var child_process = require("child_process");
+var yaml = require("js-yaml");
+
+// constants
+var DEFAULT_REPO_PATH = "README.md";
+
+function generateFrontMatter (useDirectSrcURI, filePath, name, version) {
+ var obj = {};
+
+ if(useDirectSrcURI) {
+ filePath = filePath.replace("https://raw.githubusercontent.com/", "");
+ var filePathSplit = filePath.split("/");
+ name = filePathSplit[0] + "/" + filePathSplit[1];
+ version = filePathSplit[2];
+ filePath = filePathSplit.slice(3).join("/");
+ }
+
+ obj.edit_link = getRepoURIForFrontMatter(name, version, filePath);
+ obj.note_link = "https://github.com/" + name + "/releases";
+ obj.note = "This documentation is for the " + version + " version of the " + name + ".";
+ obj.note_link_text = "Visit Github for other versions.";
--- End diff --
Please move this logic to the Jekyll side. Instead set a variable called something like `plugin_version`, and construct the link in HTML.
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by stevengill <gi...@git.apache.org>.
Github user stevengill commented on the pull request:
https://github.com/apache/cordova-docs/pull/493#issuecomment-183095394
I'm testing this now. Just pulled it into my local copy
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by purplecabbage <gi...@git.apache.org>.
Github user purplecabbage commented on the pull request:
https://github.com/apache/cordova-docs/pull/493#issuecomment-183101764
Looks good!
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on the pull request:
https://github.com/apache/cordova-docs/pull/493#issuecomment-182702522
@stevengill @purplecabbage @csantanapr please take a look.
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by csantanapr <gi...@git.apache.org>.
Github user csantanapr commented on the pull request:
https://github.com/apache/cordova-docs/pull/493#issuecomment-184499148
Sorry I'm late to this one, It looks like @stevengill already review.
Just some dumb questions
1. What impact this has to translation process?
2. Everything automated to avoid maintenance headache to keep website in sync?
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/493#discussion_r52688661
--- Diff: tools/bin/fetch_docs.js ---
@@ -0,0 +1,144 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+"use strict";
+
+var fs = require("fs");
+var fse = require("fs-extra");
+var https = require("https");
+var path = require("path");
+var child_process = require("child_process");
+var yaml = require("js-yaml");
+
+// constants
+var DEFAULT_REPO_PATH = "README.md";
+
+function generateFrontMatter (useDirectSrcURI, filePath, name, version) {
+ var obj = {};
+
+ if(useDirectSrcURI) {
+ filePath = filePath.replace("https://raw.githubusercontent.com/", "");
+ var filePathSplit = filePath.split("/");
+ name = filePathSplit[0] + "/" + filePathSplit[1];
+ version = filePathSplit[2];
+ filePath = filePathSplit.slice(3).join("/");
+ }
--- End diff --
Please use a regex here.
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by stevengill <gi...@git.apache.org>.
Github user stevengill commented on the pull request:
https://github.com/apache/cordova-docs/pull/493#issuecomment-183105034
Just finished my run through.
LGTM.
It is nice to not leave the site to see the docs. I also like how it pulls the latest release and warns users about the version. More useful than npm's readme.
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/493#discussion_r52804771
--- Diff: www/_layouts/docs.html ---
@@ -183,6 +183,21 @@ <h2 class="site-toc-title">{{ page.toc_text }}</h2>
{% endif %}
+ <!-- Show warnings for special versions (i.e. non-latest, and dev) -->
+ {% if page.note_link and page.note_link_text %}
+
+ <div class="alert alert-warning docs-alert" role="alert">
+ <button type="button" class="close" data-dismiss="alert" aria-label="Close">
+ <span aria-hidden="true">×</span>
+ </button>
+ {{ page.note }}
+ <a href="{{ page.note_link }}">
+ {{ page.note_link_text }}
+ </a>
+ </div>
+
+ {% endif %}
--- End diff --
Done
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/cordova-docs/pull/493
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on the pull request:
https://github.com/apache/cordova-docs/pull/493#issuecomment-183505615
@dblotsky Can you review and merge this PR?
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/493#discussion_r52689198
--- Diff: www/_layouts/docs.html ---
@@ -183,6 +183,21 @@ <h2 class="site-toc-title">{{ page.toc_text }}</h2>
{% endif %}
+ <!-- Show warnings for special versions (i.e. non-latest, and dev) -->
+ {% if page.note_link and page.note_link_text %}
+
+ <div class="alert alert-warning docs-alert" role="alert">
+ <button type="button" class="close" data-dismiss="alert" aria-label="Close">
+ <span aria-hidden="true">×</span>
+ </button>
+ {{ page.note }}
+ <a href="{{ page.note_link }}">
+ {{ page.note_link_text }}
+ </a>
+ </div>
+
+ {% endif %}
--- End diff --
Please adjust this code with respect to the comment on `fetch_docs.js`, and to trigger when `plugin_version` is specified.
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on the pull request:
https://github.com/apache/cordova-docs/pull/493#issuecomment-183092935
@sarangan12 looks like the mailing list is quiet about this. @riknoll any feedback?
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/493#discussion_r52804789
--- Diff: tools/bin/fetch_docs.js ---
@@ -0,0 +1,144 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+"use strict";
+
+var fs = require("fs");
+var fse = require("fs-extra");
+var https = require("https");
+var path = require("path");
+var child_process = require("child_process");
+var yaml = require("js-yaml");
+
+// constants
+var DEFAULT_REPO_PATH = "README.md";
+
+function generateFrontMatter (useDirectSrcURI, filePath, name, version) {
+ var obj = {};
+
+ if(useDirectSrcURI) {
+ filePath = filePath.replace("https://raw.githubusercontent.com/", "");
+ var filePathSplit = filePath.split("/");
+ name = filePathSplit[0] + "/" + filePathSplit[1];
+ version = filePathSplit[2];
+ filePath = filePathSplit.slice(3).join("/");
+ }
+
+ obj.edit_link = getRepoURIForFrontMatter(name, version, filePath);
+ obj.note_link = "https://github.com/" + name + "/releases";
+ obj.note = "This documentation is for the " + version + " version of the " + name + ".";
+ obj.note_link_text = "Visit Github for other versions.";
--- End diff --
Done
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/493#discussion_r52804754
--- Diff: tools/bin/fetch_docs.js ---
@@ -0,0 +1,144 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+"use strict";
+
+var fs = require("fs");
+var fse = require("fs-extra");
+var https = require("https");
+var path = require("path");
+var child_process = require("child_process");
+var yaml = require("js-yaml");
+
+// constants
+var DEFAULT_REPO_PATH = "README.md";
+
+function generateFrontMatter (useDirectSrcURI, filePath, name, version) {
+ var obj = {};
+
+ if(useDirectSrcURI) {
+ filePath = filePath.replace("https://raw.githubusercontent.com/", "");
+ var filePathSplit = filePath.split("/");
+ name = filePathSplit[0] + "/" + filePathSplit[1];
+ version = filePathSplit[2];
+ filePath = filePathSplit.slice(3).join("/");
+ }
--- End diff --
Done
---
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
[GitHub] cordova-docs pull request: CB-10552: Pull all the plugin docs to C...
Posted by stevengill <gi...@git.apache.org>.
Github user stevengill commented on the pull request:
https://github.com/apache/cordova-docs/pull/493#issuecomment-183096395
BTW, I had a merge conflict when pulling this in. Need to rebase this off the latest master I believe.
---
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