Merge pull request #302 from seanmadsen/mkdocs-yml

Clean up mkdocs.yml

docs/api/joins.md

@@ -49,9 +49,10 @@ $result = civicrm_api3('Event', 'get', array(
 
 ## Identifying fields eligible for a join
 
-It is possible to join an entity to any other entity if the [xml](/core/architecture.md#xml)
-schema identifies a [foreign key](https://en.wikipedia.org/wiki/Foreign_key) or
-a pseudoconstant.  The [getfields](/api/actions.md#getfields) action identifies
+It is possible to join an entity to any other entity if the
+[xml schema](/framework/database/schema-definition.md)
+identifies a [foreign key](/framework/database/schema-definition.md#table-foreignKey) or
+a [pseudoconstant](/framework/database/schema-definition.md#table-field-pseudoconstant).  The [getfields](/api/actions.md#getfields) action identifies
 fields that are eligible for an API join.
 
 !!! warning

docs/extensions/civix.md

@@ -193,7 +193,7 @@ to create a new entity. For this, you can use the command `civix generate:entity
 
 1. Edit the [XML schema definitions](/framework/database/schema-definition.md) in the `xml` folder to define your desired fields.
 
-1. Generate a [DAO file](/core/architecture.md#dao) and SQL to create your table. *(For now, civix does not handle this part. Hopefully these steps will become easier at some point in the future.)*
+1. Generate a [DAO file](/framework/codebase.md#dao) and SQL to create your table. *(For now, civix does not handle this part. Hopefully these steps will become easier at some point in the future.)*
 
     1. Begin with a *development* installation of CiviCRM core.
 

docs/tools/debugging.md

@@ -51,7 +51,7 @@ A backtrace is a list of all the functions that were run in the execution of the
 ## Viewing log files
 
 CiviCRM's log files are stored in the `ConfigAndLog` directory within CiviCRM's
-local file storage (see [the File System documentation](/basics/filesystem.md)
+local file storage (see [the File System documentation](/framework/filesystem.md)
 for details on your CMS).  Most runtime errors are logged here, as well as data
 that you explicitly write to log using the `CRM_Core_Error::debug log=true`
 parameter.
@@ -78,7 +78,7 @@ The following values can be added to your site's settings file `civicrm.settings
     When any sort of "logging stuff to a file" is enabled by one of the
     above settings, check the `ConfigAndLog` directory within the local files
     directory to find the log.  (See [the File System
-    documentation](../basics/filesystem.md) for the location in your CMS.)
+    documentation](/framework/filesystem.md) for the location in your CMS.)
 
 !!! tip
     If you're developing within a site built with [civibuild](/tools/civibuild.md), then you can to apply settings to *all your local sites* by using the [civicrm.settings.d folders](/tools/civibuild.md#settings-civicrm).

mkdocs.yml

@@ -11,9 +11,8 @@ pages:
   - Requirements: basics/requirements.md
   - Useful Skills: basics/skills.md
   - Planning Your Project: basics/planning.md
-  - File System: basics/filesystem.md
-- Development tools:
-  - Development tools: tools/index.md
+- Tools:
+  - Development Tools: tools/index.md
   - Buildkit: tools/buildkit.md
   - civibuild: tools/civibuild.md
   - cividist: tools/cividist.md
@@ -23,88 +22,25 @@ pages:
   - Jenkins: tools/jenkins.md
   - PhpStorm: tools/phpstorm.md
   - Debugging: tools/debugging.md
-- Core Development:
+- Core:
   - When to Edit Core: core/hacking.md
-  - Release process: core/release-process.md
   - How to Contribute: core/contributing.md
   - Reviewing PR's: core/pr-review.md
-  - Codebase & Architecture: core/architecture.md
-  # Reporting Bugs & Issues: /core/reporting.md
-  # Submitting a Patch: /core/patches.md
-  # Verifying a Bug Fix: /core/verifying.md
-- Extensions Development:
+  - Release Process: core/release-process.md
+- Extensions:
   - Basics: extensions/index.md
-  - Packaging options: extensions/packaging.md
+  - Packaging Options: extensions/packaging.md
   - civix: extensions/civix.md
   - Extension Structure: extensions/structure.md
-  - info.xml file: extensions/info-xml.md
-  # Creating Pages: extensions/create-page.md
-  # Storing Configuration: extensions/config.md
-  # Storing Data: extensions/storing-data.md
-  # Setting Permissions: extensions/permissions.md
-  # Adding API Functions: extensions/api.md
-  # Reports: extensions/reports.md
-  # Searches: extensions/searches.md
-  # Payment Processors: extensions/payment-processors.md
+  - info.xml File: extensions/info-xml.md
   - Publishing Extensions: extensions/publish.md
   - Extension Lifecycle: extensions/lifecycle.md
   - Troubleshooting: extensions/troubleshooting.md
-  - Advanced patterns: extensions/advanced.md
+  - Advanced Patterns: extensions/advanced.md
   - Payment Processors:
     - Payment Processors: extensions/payment-processors/index.md
     - Payment Processor Types: extensions/payment-processors/types.md
     - Creating a Payment Processor: extensions/payment-processors/create.md
-- Testing:
-  - Testing Setup: testing/setup.md
-  - "PHPUnit Tests": testing/phpunit.md
-  - "Javascript Tests": testing/javascript.md
-  - "Selinium Tests": testing/selinium.md
-  - "Continuous Integration": testing/continuous-integration.md
-  - "Upgrade Tests": testing/upgrades.md
-  - Manual Testing: testing/manual.md
-- Framework Reference:
-  - AngularJS:
-    - "AngularJS: Intro": framework/angular/index.md
-    - "AngularJS: Quick Start": framework/angular/quickstart.md
-    - "AngularJS: File Names": framework/angular/files.md
-    - "AngularJS: Loader": framework/angular/loader.md
-    - "AngularJS: Changesets":  framework/angular/changeset.md
-  - "API architecture": framework/api-architecture.md
-  - Asset Builder: framework/asset-builder.md
-  - Bootstrap Process: framework/bootstrap.md
-  - Backbone Reference: framework/backbone.md
-  - Cache Reference: framework/cache.md
-  - AJAX Pages and Forms Reference: framework/ajax.md
-  # Components: /framework/components.md
-  - Database: 
-    - Overview: framework/database/index.md
-    - XML Schema definition: framework/database/schema-definition.md
-    - Schema Design: framework/database/schema-design.md
-    - Transaction Reference: framework/database/transactions.md
-  - Resources Reference: framework/resources.md
-  - UI Reference: framework/ui.md
-  - Region Reference: framework/region.md
-  - Upgrade Reference: framework/upgrade.md
-  - Setting Reference: framework/setting.md
-  - QuickForm Reference:
-     - QuickForm: framework/quickform/index.md
-     - Entity Reference Field: framework/quickform/entityref.md
-  - Template Reference:
-    - Templates: framework/templates/index.md
-    - Customizing templates: framework/templates/customizing.md
-    - Extending Smarty: framework/templates/extending-smarty.md
-  - PseudoConstant Reference: framework/pseudoconstant.md
-  # Other Reference:
-  - CiviMail: framework/civimail.md
-  - CiviReport: framework/civireport.md
-  # Payment Processing: /reference/payment.md
-- Security:
-  - Secure Coding: security/index.md
-  - Securing Inputs: security/inputs.md
-  - Securing Outputs: security/outputs.md
-  - Permissions: security/permissions.md
-  - Access Control: security/access.md
-  - Reporting Vulnerabilities: security/reporting.md
 - API:
   - APIv3 Intro: api/index.md
   - APIv3 Usage: api/usage.md
@@ -117,22 +53,22 @@ pages:
   - APIv3 Interfaces: api/interfaces.md
   - APIv3 Changes: api/changes.md
 - Hooks:
-  - Using hooks: hooks/index.md
-  - All hooks: hooks/list.md
+  - Using Hooks: hooks/index.md
+  - All Hooks: hooks/list.md
   - Setup:
     - Hooks with Symfony: hooks/setup/symfony.md
     - Hooks with Joomla: hooks/setup/joomla.md
     - Hooks with Drupal: hooks/setup/drupal.md
     - Hooks with Wordpress: hooks/setup/wordpress.md
-  - Batch hooks:
+  - Batch Hooks:
     - hook_civicrm_batchItems: hooks/hook_civicrm_batchItems.md
     - hook_civicrm_batchQuery: hooks/hook_civicrm_batchQuery.md
-  - Case hooks:
+  - Case Hooks:
     - hook_civicrm_caseChange: hooks/hook_civicrm_caseChange.md
     - hook_civicrm_caseTypes: hooks/hook_civicrm_caseTypes.md
     - hook_civicrm_post_case_merge: hooks/hook_civicrm_post_case_merge.md
     - hook_civicrm_pre_case_merge: hooks/hook_civicrm_pre_case_merge.md
-  - Database hooks:
+  - Database Hooks:
     - hook_civicrm_copy: hooks/hook_civicrm_copy.md
     - hook_civicrm_custom: hooks/hook_civicrm_custom.md
     - hook_civicrm_managed: hooks/hook_civicrm_managed.md
@@ -142,16 +78,16 @@ pages:
     - hook_civicrm_pre: hooks/hook_civicrm_pre.md
     - hook_civicrm_triggerInfo: hooks/hook_civicrm_triggerInfo.md
     - hook_civicrm_referenceCounts: hooks/hook_civicrm_referenceCounts.md
-  - Entity hooks:
+  - Entity Hooks:
     - hook_civicrm_entityTypes: hooks/hook_civicrm_entityTypes.md
-  - Extension lifecycle hooks:
+  - Extension Hifecycle Hooks:
     - hook_civicrm_disable: hooks/hook_civicrm_disable.md
     - hook_civicrm_enable: hooks/hook_civicrm_enable.md
     - hook_civicrm_install: hooks/hook_civicrm_install.md
     - hook_civicrm_postInstall: hooks/hook_civicrm_postInstall.md
     - hook_civicrm_uninstall: hooks/hook_civicrm_uninstall.md
     - hook_civicrm_upgrade: hooks/hook_civicrm_upgrade.md
-  - Form hooks:
+  - Form Hooks:
     - hook_civicrm_alterContent: hooks/hook_civicrm_alterContent.md
     - hook_civicrm_alterTemplateFile: hooks/hook_civicrm_alterTemplateFile.md
     - hook_civicrm_buildForm: hooks/hook_civicrm_buildForm.md
@@ -160,7 +96,7 @@ pages:
     - hook_civicrm_preProcess: hooks/hook_civicrm_preProcess.md
     - <del>hook_civicrm_validate</del>: hooks/hook_civicrm_validate.md
     - hook_civicrm_validateForm: hooks/hook_civicrm_validateForm.md
-  - GUI hooks:
+  - GUI Hooks:
     - hook_civicrm_alterMenu: hooks/hook_civicrm_alterMenu.md
     - hook_civicrm_buildAmount: hooks/hook_civicrm_buildAmount.md
     - hook_civicrm_caseSummary: hooks/hook_civicrm_caseSummary.md
@@ -179,7 +115,7 @@ pages:
     - <del>hook_civicrm_tabs</del>: hooks/hook_civicrm_tabs.md
     - hook_civicrm_tabset: hooks/hook_civicrm_tabset.md
     - hook_civicrm_xmlMenu: hooks/hook_civicrm_xmlMenu.md
-  - Mail hooks:
+  - Mail Hooks:
     - hook_civicrm_alterMailContent: hooks/hook_civicrm_alterMailContent.md
     - hook_civicrm_alterMailer: hooks/hook_civicrm_alterMailer.md
     - hook_civicrm_alterMailParams: hooks/hook_civicrm_alterMailParams.md
@@ -189,25 +125,25 @@ pages:
     - hook_civicrm_postEmailSend: hooks/hook_civicrm_postEmailSend.md
     - hook_civicrm_postMailing: hooks/hook_civicrm_postMailing.md
     - hook_civicrm_unsubscribeGroups: hooks/hook_civicrm_unsubscribeGroups.md
-  - Permission hooks:
+  - Permission Hooks:
     - hook_civicrm_aclGroup: hooks/hook_civicrm_aclGroup.md
     - hook_civicrm_aclWhereClause: hooks/hook_civicrm_aclWhereClause.md
     - hook_civicrm_alterAPIPermissions: hooks/hook_civicrm_alterAPIPermissions.md
     - hook_civicrm_permission: hooks/hook_civicrm_permission.md
     - hook_civicrm_permission_check: hooks/hook_civicrm_permission_check.md
     - hook_civicrm_selectWhereClause: hooks/hook_civicrm_selectWhereClause.md
-  - Profile hooks:
+  - Profile Hooks:
     - hook_civicrm_buildProfile: hooks/hook_civicrm_buildProfile.md
     - hook_civicrm_buildUFGroupsForModule: hooks/hook_civicrm_buildUFGroupsForModule.md
     - hook_civicrm_processProfile: hooks/hook_civicrm_processProfile.md
     - hook_civicrm_searchProfile: hooks/hook_civicrm_searchProfile.md
     - hook_civicrm_validateProfile: hooks/hook_civicrm_validateProfile.md
     - hook_civicrm_viewProfile: hooks/hook_civicrm_viewProfile.md
-  - Report hooks:
+  - Report Hooks:
     - hook_civicrm_alterReportVar: hooks/hook_civicrm_alterReportVar.md
-  - SMS hooks:
+  - SMS Hooks:
     - hook_civicrm_inboundSMS: hooks/hook_civicrm_inboundSMS.md
-  - Uncategorized hooks:
+  - Uncategorized Hooks:
     - hook_civicrm_alterBadge: hooks/hook_civicrm_alterBadge.md
     - hook_civicrm_alterBarcode: hooks/hook_civicrm_alterBarcode.md
     - hook_civicrm_alterCalculatedMembershipStatus: hooks/hook_civicrm_alterCalculatedMembershipStatus.md
@@ -241,13 +177,61 @@ pages:
     - hook_civicrm_tokens: hooks/hook_civicrm_tokens.md
     - hook_civicrm_tokenValues: hooks/hook_civicrm_tokenValues.md
     - hook_civicrm_unhandledException: hooks/hook_civicrm_unhandledException.md
+- Testing:
+  - Testing Setup: testing/setup.md
+  - PHPUnit Tests: testing/phpunit.md
+  - Javascript Tests: testing/javascript.md
+  - Selinium Tests: testing/selinium.md
+  - Continuous Integration: testing/continuous-integration.md
+  - Upgrade Tests: testing/upgrades.md
+  - Manual Testing: testing/manual.md
+- Security:
+  - Secure Coding: security/index.md
+  - Securing Inputs: security/inputs.md
+  - Securing Outputs: security/outputs.md
+  - Permissions: security/permissions.md
+  - Access Control: security/access.md
+  - Reporting Vulnerabilities: security/reporting.md
+- Framework Reference:
+  - AJAX Pages and Forms Reference: framework/ajax.md
+  - AngularJS:
+    - AngularJS Intro: framework/angular/index.md
+    - AngularJS Quick Start: framework/angular/quickstart.md
+    - AngularJS File Names: framework/angular/files.md
+    - AngularJS Loader: framework/angular/loader.md
+    - AngularJS Changesets:  framework/angular/changeset.md
+  - API Architecture: framework/api-architecture.md
+  - Asset Builder: framework/asset-builder.md
+  - Bootstrap Process: framework/bootstrap.md
+  - Backbone Reference: framework/backbone.md
+  - Cache Reference: framework/cache.md
+  - CiviMail: framework/civimail.md
+  - CiviReport: framework/civireport.md
+  - Codebase: framework/codebase.md
+  - Database:
+    - Overview: framework/database/index.md
+    - XML Schema definition: framework/database/schema-definition.md
+    - Schema Design: framework/database/schema-design.md
+    - Transaction Reference: framework/database/transactions.md
+  - File System: framework/filesystem.md
+  - PseudoConstant Reference: framework/pseudoconstant.md
+  - QuickForm Reference:
+     - QuickForm: framework/quickform/index.md
+     - Entity Reference Field: framework/quickform/entityref.md
+  - Region Reference: framework/region.md
+  - Resources Reference: framework/resources.md
+  - Setting Reference: framework/setting.md
+  - Template Reference:
+    - Templates: framework/templates/index.md
+    - Customizing Templates: framework/templates/customizing.md
+    - Extending Smarty: framework/templates/extending-smarty.md
+  - UI Reference: framework/ui.md
+  - Upgrade Reference: framework/upgrade.md
 - Coding Standards:
   - Coding Standards: standards/index.md
   - PHP Standards: standards/php.md
   - Javascript Reference: standards/javascript.md
   - Database Standards: standards/database.md
-  # API: standards/api.md
-  # Git: standards/git.md
 - Documentation:
   - Writing Documentation: documentation/index.md
   - Documenting Extensions: documentation/extensions.md

redirects/internal.txt

@@ -8,3 +8,5 @@ hooks/hook_civicrm_trigger_info hooks/hook_civicrm_triggerInfo
 framework/schema-definition framework/database/schema-definition
 api/params api/options
 core/develop tools/git
+basics/filesystem framework/filesystem
+core/architecture framework/codebase