瀏覽代碼

Merge pull request #6 from theshka/gh-pages

Update plugin-dev pages
Daniel Rudolf 9 年之前
父節點
當前提交
87332ecfe0
共有 5 個文件被更改,包括 23 次插入15 次删除
  1. 17 9
      _plugin-dev/basics.md
  2. 1 1
      _plugin-dev/core.md
  3. 3 3
      _plugin-dev/plugins.md
  4. 1 1
      _plugin-dev/wiki.md
  5. 1 1
      plugin-dev.html

+ 17 - 9
_plugin-dev/basics.md

@@ -3,18 +3,16 @@ toc:
     basics:
     basics:
         _title: Basics
         _title: Basics
         versioning: Versioning
         versioning: Versioning
-        build_&_release: Build & Release
+        build--release: Build & Release
 nav: 1
 nav: 1
 ---
 ---
 
 
 # Basics
 # Basics
 Creating your own content for Pico is *easy*.
 Creating your own content for Pico is *easy*.
 
 
-Inside the root Pico folder, all *themes* reside in the `themes` directory,
-and all *plugins* in the `plugins` directory. (As a developer, you may have
-changed these paths and/or directory names when you initialized Pico.)
+Inside the root Pico folder, all *themes* reside in the `themes` directory, and all *plugins* in the `plugins` directory. (As a developer, you may have changed these paths and/or directory names when you initialized Pico.)
 
 
-Besides this documentation please also refer to our [phpDoc](phpDocumentor/).
+Note that if you are submitting pull requests they should be small (i.e. one feature per request), stick to existing coding conventions and documentation should be updated if required.
 
 
 # Versioning
 # Versioning
 Pico uses Semantic Versioning. Given a version number MAJOR.MINOR.PATCH, increment the:
 Pico uses Semantic Versioning. Given a version number MAJOR.MINOR.PATCH, increment the:
@@ -26,11 +24,21 @@ Pico uses Semantic Versioning. Given a version number MAJOR.MINOR.PATCH, increme
 For more information see the [http://semver.org](http://semver.org) website.
 For more information see the [http://semver.org](http://semver.org) website.
 
 
 # Build & Release
 # Build & Release
-Defined below is a specification to which the Build and Release process of Pico should follow.
-Each commit to `master` should be releasable, otherwise make use of the `development` branch.
+Defined below is a specification to which the Build and Release process of Pico should follow. We use `travis-ci` to automate the process, and each commit to `master` should be releasable.
 
 
 ### Commit phase
 ### Commit phase
+- Commit changes
 - Create & Push Git tag
 - Create & Push Git tag
+- Trigger automatic build process...
+
+Example commit message:
+
+    Pico 1.0.1
+    * [New] ...
+    * [Changed] ...
+
+*Please submit pull-requests with a properly
+formatted commit message/SemVer increase to avoid the need for manual amendments.*
 
 
 ### Analysis phase
 ### Analysis phase
 - Run through `scrutinizer-ci`?
 - Run through `scrutinizer-ci`?
@@ -38,7 +46,7 @@ Each commit to `master` should be releasable, otherwise make use of the `develop
 ### Packaging phase
 ### Packaging phase
 - Run composer locally
 - Run composer locally
 - Create a ZIP archive (so vendor/ is included)
 - Create a ZIP archive (so vendor/ is included)
-- Build documentation, output goes to a new folder in the gh-pages branch
+- Build documentation, output goes to a new folder in the `gh-pages` branch
 
 
 ### Release phase
 ### Release phase
 - Create new Git release at tag
 - Create new Git release at tag
@@ -50,4 +58,4 @@ Each commit to `master` should be releasable, otherwise make use of the `develop
     - Changelog
     - Changelog
 
 
 ### Announcements
 ### Announcements
-- 
+- Where to announce new Pico release?

+ 1 - 1
_plugin-dev/core.md

@@ -1,6 +1,6 @@
 ---
 ---
 toc:
 toc:
-    core:
+    pico-core:
         _title: Core
         _title: Core
 
 
 nav: 2
 nav: 2

+ 3 - 3
_plugin-dev/plugins.md

@@ -2,8 +2,8 @@
 toc:
 toc:
     plugins:
     plugins:
         _title: Plugins
         _title: Plugins
-        migrating: Migrating 0.X -> 1.0
-        your_first: Your First Plugin
+        migrating-from-0x---10: Migrating 0.X -> 1.0
+        your-first-plugin: Your First Plugin
 nav: 3
 nav: 3
 ---
 ---
 
 
@@ -14,7 +14,7 @@ You will find a full example template in `plugins/DummyPlugin.php` to get you
 started on building some great stuff. Otherwise, keep reading to learn how to
 started on building some great stuff. Otherwise, keep reading to learn how to
 create your first plugin!
 create your first plugin!
 
 
-Officially tested plugins can be found at http://pico.dev7studios.com/plugins,
+Officially tested plugins can be found at [http://picocms.org/plugins](http://picocms.org/plugins),
 but there are many awesome third-party plugins out there! A good start point
 but there are many awesome third-party plugins out there! A good start point
 for discovery is our [Wiki](#plugin-wiki).
 for discovery is our [Wiki](#plugin-wiki).
 
 

+ 1 - 1
_plugin-dev/wiki.md

@@ -1,6 +1,6 @@
 ---
 ---
 toc:
 toc:
-    wiki: Wiki
+    plugin-wiki: Wiki
 nav: 3
 nav: 3
 ---
 ---
 
 

+ 1 - 1
plugin-dev.html

@@ -9,7 +9,7 @@ nav: 3
     <div class="inner">
     <div class="inner">
         <h1 class="aligncenter">Create your own plugins &amp; themes</h1>
         <h1 class="aligncenter">Create your own plugins &amp; themes</h1>
         <p class="description aligncenter">
         <p class="description aligncenter">
-            Pico is highly customizable - the possibilites are endless when you're in control.
+            Below is our developer documentation, you may also refer to Pico's <a href="phpDocumentor/">class documentation</a>
         </p><br />
         </p><br />
 
 
         <div class="one-fourth">
         <div class="one-fourth">