You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by dblotsky <gi...@git.apache.org> on 2016/01/23 00:39:23 UTC
[GitHub] cordova-docs pull request: Multi-level ToC Implementation
GitHub user dblotsky opened a pull request:
https://github.com/apache/cordova-docs/pull/464
Multi-level ToC Implementation
- Added support for nested ToCs using the `children` attribute
- Retroactively made past ToC files use relative links
- Made all dev ToCs use the new documentation information architecture
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/MSOpenTech/cordova-docs nested-toc
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/cordova-docs/pull/464.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 #464
----
commit 43491ea7a3ede171e003eefc384cbd4e7037c900
Author: Dmitry Blotsky <dm...@gmail.com>
Date: 2016-01-16T06:11:54Z
Added new IA for English dev docs. Made paths in ToC files relative (i.e. removed the redundant /docs/[lang]/[version]). Made docs template support new ToC changes.
commit 5021bd84d309492446beb8e0b5f8e4610428463c
Author: Dmitry Blotsky <dm...@gmail.com>
Date: 2016-01-22T22:51:54Z
Retroactively fixed previous ToC versions to use relative links.
----
---
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: Multi-level ToC Implementation
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on the pull request:
https://github.com/apache/cordova-docs/pull/464#issuecomment-177052823
This looks great! One issue: "Architecture" has no children with URLs and it shows up in the TOC.
---
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: Multi-level ToC Implementation
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/464#discussion_r50610703
--- Diff: www/_data/toc/de-dev-manual.yml ---
@@ -1,19 +1,70 @@
-- {name: "Reisef\xFChrer", url: !!python/unicode '/docs/de/dev/'}
-- {name: "\xDCbersicht", url: !!python/unicode '/docs/de/dev/guide/overview/index.html'}
-- {name: "Plattformunterst\xFCtzung", url: !!python/unicode '/docs/de/dev/guide/support/index.html'}
-- {name: !!python/unicode 'Die Befehlszeilenschnittstelle', url: !!python/unicode '/docs/de/dev/guide/cli/index.html'}
-- {name: !!python/unicode 'Plattform-Guides', url: !!python/unicode '/docs/de/dev/guide/platforms/index.html'}
-- {name: !!python/unicode 'Plugins verwalten mithilfe Plugman', url: !!python/unicode '/docs/de/dev/plugin_ref/plugman.html'}
-- {name: !!python/unicode 'Die Datei config.xml', url: !!python/unicode '/docs/de/dev/config_ref/index.html'}
-- {name: !!python/unicode 'Symbole und Splash-Screens', url: !!python/unicode '/docs/de/dev/config_ref/images.html'}
-- {name: "Einbetten von Webansichten f\xFCr", url: !!python/unicode '/docs/de/dev/guide/hybrid/webviews/index.html'}
-- {name: !!python/unicode 'Plugin-Entwicklung-Guide', url: !!python/unicode '/docs/de/dev/guide/hybrid/plugins/index.html'}
-- {name: !!python/unicode 'Plugin-Spezifikation', url: !!python/unicode '/docs/de/dev/plugin_ref/spec.html'}
-- {name: !!python/unicode 'Datenschutz-Guide', url: !!python/unicode '/docs/de/dev/guide/appdev/privacy/index.html'}
-- {name: !!python/unicode 'Sicherheitshandbuch', url: !!python/unicode '/docs/de/dev/guide/appdev/security/index.html'}
-- {name: !!python/unicode 'Plattformen und Plugins Versionsmanagement', url: !!python/unicode '/docs/de/dev/platform_plugin_versioning_ref/index.html'}
-- {name: !!python/unicode 'Whitelist-Guide', url: !!python/unicode '/docs/de/dev/guide/appdev/whitelist/index.html'}
-- {name: "Die n\xE4chsten Schritte", url: !!python/unicode '/docs/de/dev/guide/next/index.html'}
-- {name: !!python/unicode 'Veranstaltungen', url: !!python/unicode '/docs/de/dev/cordova/events/events.html'}
-- {name: !!python/unicode 'Plugin APIs', url: !!python/unicode '/docs/de/dev/cordova/plugins/pluginapis.html'}
-- {name: !!python/unicode 'Stichwort-Index', url: !!python/unicode '/docs/de/dev/page_index.html'}
+- name: "Overview"
+ url: "guide/overview/index.html"
+- name: "Architecture"
+ children:
+ - name: "Runtime Architecture"
+ url:
+ - name: "Tooling Architecture"
+ url:
+- name: "Create apps"
+ children:
+ - name: "Create your first app"
+ url:
+ - name: "Develop for platforms"
+ url: "guide/platforms/index.html"
+ - name: "Manage versions and platforms"
+ url:
--- End diff --
This article is present in current TOC. platform_plugin_versioning_ref/index.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: Multi-level ToC Implementation
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on the pull request:
https://github.com/apache/cordova-docs/pull/464#issuecomment-175183412
If an article does not have a URL do we make sure it does not show up in the displayed page?
---
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: Multi-level ToC Implementation
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on the pull request:
https://github.com/apache/cordova-docs/pull/464#issuecomment-178554331
@nikhilkh Fixed. Merging.
---
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: Multi-level ToC Implementation
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on the pull request:
https://github.com/apache/cordova-docs/pull/464#issuecomment-178351575
Could you comment "Architecture" and it's sub-sections? We might not get to write these topics till April or something. It's best to not to have empty non-clickable placeholders in TOC.
---
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: Multi-level ToC Implementation
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on the pull request:
https://github.com/apache/cordova-docs/pull/464#issuecomment-178269844
@nikhilkh that is a difficult bug to fix because it relies on knowing that all children of "Architecture" also don't have any URIs. It will start to have some pages under it very soon, so I think it's ok to have the title be empty in the short term.
---
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: Multi-level ToC Implementation
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on the pull request:
https://github.com/apache/cordova-docs/pull/464#issuecomment-175184927
Looks like there are really two changes - use of relative links & multi-level TOC. It's hard to follow but I'm assuming only newer versions of the docs do get multi-level TOC - older versions remain unchanged.
---
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: Multi-level ToC Implementation
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/cordova-docs/pull/464
---
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: Multi-level ToC Implementation
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on the pull request:
https://github.com/apache/cordova-docs/pull/464#issuecomment-176489339
@nikhilkh I made articles not show up if they don't have a URL. As for older versions, they were only updated to use relative links.
---
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: Multi-level ToC Implementation
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/464#discussion_r51210760
--- Diff: www/_data/toc/de-dev-manual.yml ---
@@ -1,19 +1,70 @@
-- {name: "Reisef\xFChrer", url: !!python/unicode '/docs/de/dev/'}
-- {name: "\xDCbersicht", url: !!python/unicode '/docs/de/dev/guide/overview/index.html'}
-- {name: "Plattformunterst\xFCtzung", url: !!python/unicode '/docs/de/dev/guide/support/index.html'}
-- {name: !!python/unicode 'Die Befehlszeilenschnittstelle', url: !!python/unicode '/docs/de/dev/guide/cli/index.html'}
-- {name: !!python/unicode 'Plattform-Guides', url: !!python/unicode '/docs/de/dev/guide/platforms/index.html'}
-- {name: !!python/unicode 'Plugins verwalten mithilfe Plugman', url: !!python/unicode '/docs/de/dev/plugin_ref/plugman.html'}
-- {name: !!python/unicode 'Die Datei config.xml', url: !!python/unicode '/docs/de/dev/config_ref/index.html'}
-- {name: !!python/unicode 'Symbole und Splash-Screens', url: !!python/unicode '/docs/de/dev/config_ref/images.html'}
-- {name: "Einbetten von Webansichten f\xFCr", url: !!python/unicode '/docs/de/dev/guide/hybrid/webviews/index.html'}
-- {name: !!python/unicode 'Plugin-Entwicklung-Guide', url: !!python/unicode '/docs/de/dev/guide/hybrid/plugins/index.html'}
-- {name: !!python/unicode 'Plugin-Spezifikation', url: !!python/unicode '/docs/de/dev/plugin_ref/spec.html'}
-- {name: !!python/unicode 'Datenschutz-Guide', url: !!python/unicode '/docs/de/dev/guide/appdev/privacy/index.html'}
-- {name: !!python/unicode 'Sicherheitshandbuch', url: !!python/unicode '/docs/de/dev/guide/appdev/security/index.html'}
-- {name: !!python/unicode 'Plattformen und Plugins Versionsmanagement', url: !!python/unicode '/docs/de/dev/platform_plugin_versioning_ref/index.html'}
-- {name: !!python/unicode 'Whitelist-Guide', url: !!python/unicode '/docs/de/dev/guide/appdev/whitelist/index.html'}
-- {name: "Die n\xE4chsten Schritte", url: !!python/unicode '/docs/de/dev/guide/next/index.html'}
-- {name: !!python/unicode 'Veranstaltungen', url: !!python/unicode '/docs/de/dev/cordova/events/events.html'}
-- {name: !!python/unicode 'Plugin APIs', url: !!python/unicode '/docs/de/dev/cordova/plugins/pluginapis.html'}
-- {name: !!python/unicode 'Stichwort-Index', url: !!python/unicode '/docs/de/dev/page_index.html'}
+- name: "Overview"
+ url: "guide/overview/index.html"
+- name: "Architecture"
+ children:
+ - name: "Runtime Architecture"
+ url:
+ - name: "Tooling Architecture"
+ url:
+- name: "Create apps"
+ children:
+ - name: "Create your first app"
+ url:
+ - name: "Develop for platforms"
+ url: "guide/platforms/index.html"
+ - name: "Manage versions and platforms"
+ url:
--- End diff --
Got it. Thanks!
---
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