tonyair/doc.silverstripe.org
1
0
Fork 0
mirror of https://github.com/silverstripe/doc.silverstripe.org synced 2024-10-22 15:05:50 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #151 from tractorcow/pulls/simple-branching

Browse Source 
API Simplify branches for docs to major versions only
This commit is contained in:
Robbie Averill 2016-12-05 11:28:11 +13:00 committed by GitHub
commit f10d4e7cc4
6 changed files with 88 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.htaccess
View File

@ -42,8 +42,14 @@ ErrorDocument 500 /assets/error-500.html
RewriteRule ^framework/en/(.*)$ /en/$1 [R=301,NC,QSA,L] RewriteRule ^framework/en/(.*)$ /en/$1 [R=301,NC,QSA,L]
# Docs in /contributing are version agnostic, and should always point to latest # Docs in /contributing are version agnostic, and should always point to latest
RewriteCond %{REQUEST_URI} !(4.0) RewriteCond %{REQUEST_URI} !(4)
RewriteRule ^(.*)/(.*)/contributing/?(.*)?$ /$1/4.0/contributing/$3 [R=301,L] RewriteRule ^(.*)/(.*)/contributing/?(.*)?$ /$1/4/contributing/$3 [R=301,L]
# Redirect 4.0 docs to 4 (new major version)
RewriteRule ^en/4\.0/(.*)?$ /en/4/$1 [R=301,L]
# Redirect any version > 3.4 to 3 branch
RewriteRule ^en/3\.[5-9]/(.*)?$ /en/3/$1 [R=301,L]
# DokuWiki rewrite rules: Need to happen before other rules in order to redirect /doku.php?id=<pagename> # DokuWiki rewrite rules: Need to happen before other rules in order to redirect /doku.php?id=<pagename>
# to /pagename, which can then be matched by the legacy rewrite rules further down # to /pagename, which can then be matched by the legacy rewrite rules further down

22
app/_config/docs-repositories.yml
View File

@ -13,24 +13,4 @@ RefreshMarkdownTask:
- -
- silverstripe/silverstripe-framework - silverstripe/silverstripe-framework
- framework - framework
- "3.4" - "3"
-
- silverstripe/silverstripe-framework
- framework
- "3.3"
-
- silverstripe/silverstripe-framework
- framework
- "3.2"
-
- silverstripe/silverstripe-framework
- framework
- "3.1"
-
- silverstripe/silverstripe-framework
- framework
- "3.0"
-
- silverstripe/silverstripe-framework
- framework
- "2.4"

24
app/_config/docsviewer.yml
View File

@ -12,39 +12,59 @@ DocumentationManifest:
- -
Path: "assets/src/framework_master/docs/" Path: "assets/src/framework_master/docs/"
Title: "Framework" Title: "Framework"
Version: "4.0" VersionTitle: "4.x"
Version: "4"
Branch: "master" Branch: "master"
DefaultEntity: true DefaultEntity: true
-
Path: "assets/src/framework_3/docs/"
Title: "Framework"
VersionTitle: "3.x"
Version: "3"
Branch: "3"
Stable: true
DefaultEntity: true
- -
Path: "assets/src/framework_3.4/docs/" Path: "assets/src/framework_3.4/docs/"
Title: "Framework" Title: "Framework"
VersionTitle: "3.4"
Version: "3.4" Version: "3.4"
Branch: "3.4" Branch: "3.4"
Stable: true Archived: true
DefaultEntity: true DefaultEntity: true
- -
Path: "assets/src/framework_3.3/docs/" Path: "assets/src/framework_3.3/docs/"
Title: "Framework" Title: "Framework"
VersionTitle: "3.3"
Version: "3.3" Version: "3.3"
Branch: "3.3" Branch: "3.3"
Archived: true
DefaultEntity: true DefaultEntity: true
- -
Path: "assets/src/framework_3.2/docs/" Path: "assets/src/framework_3.2/docs/"
Title: "Framework" Title: "Framework"
VersionTitle: "3.3"
Version: "3.2" Version: "3.2"
Archived: true
DefaultEntity: true DefaultEntity: true
- -
Path: "assets/src/framework_3.1/docs/" Path: "assets/src/framework_3.1/docs/"
Title: "Framework" Title: "Framework"
VersionTitle: "3.1"
Version: "3.1" Version: "3.1"
Archived: true
DefaultEntity: true DefaultEntity: true
- -
Path: "assets/src/framework_3.0/docs/" Path: "assets/src/framework_3.0/docs/"
Title: "Framework" Title: "Framework"
VersionTitle: "3.0"
Version: "3.0" Version: "3.0"
Archived: true
DefaultEntity: true DefaultEntity: true
- -
Path: "assets/src/framework_2.4/docs/" Path: "assets/src/framework_2.4/docs/"
Title: "Framework" Title: "Framework"
VersionTitle: "2.4"
Version: "2.4" Version: "2.4"
Archived: true
DefaultEntity: true DefaultEntity: true

7
composer.json
View File

@ -4,7 +4,7 @@
"require": { "require": {
"ext-gd": "*", "ext-gd": "*",
"ext-mbstring": "*", "ext-mbstring": "*",
"silverstripe/docsviewer": "dev-master", "silverstripe/docsviewer": "^2.0@beta",
"silverstripe/framework": "^3.2", "silverstripe/framework": "^3.2",
"silverstripe/toolbar": "^4.2", "silverstripe/toolbar": "^4.2",
"silverstripe/dynamodb": "^1.1", "silverstripe/dynamodb": "^1.1",
@ -23,8 +23,5 @@
"process-timeout": 600 "process-timeout": 600
}, },
"minimum-stability": "dev", "minimum-stability": "dev",
"prefer-stable": true, "prefer-stable": true
"scripts": {
}
} }

71
composer.lock generated
View File

@ -4,8 +4,8 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file", "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
"This file is @generated automatically" "This file is @generated automatically"
], ],
"hash": "e6ed503e08d9e9ccf302c7fe3057b177", "hash": "fe77eae7f153ec8d70ba905ae736c1f3",
"content-hash": "8c652b05aa3bdebb477f26c03e4cd66b", "content-hash": "db0fd420bda434d99cd25d69e6acf238",
"packages": [ "packages": [
{ {
"name": "aws/aws-sdk-php", "name": "aws/aws-sdk-php",
@ -179,16 +179,16 @@
}, },
{ {
"name": "doctrine/cache", "name": "doctrine/cache",
"version": "v1.6.0", "version": "v1.6.1",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/doctrine/cache.git", "url": "https://github.com/doctrine/cache.git",
"reference": "f8af318d14bdb0eff0336795b428b547bd39ccb6" "reference": "b6f544a20f4807e81f7044d31e679ccbb1866dc3"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/doctrine/cache/zipball/f8af318d14bdb0eff0336795b428b547bd39ccb6", "url": "https://api.github.com/repos/doctrine/cache/zipball/b6f544a20f4807e81f7044d31e679ccbb1866dc3",
"reference": "f8af318d14bdb0eff0336795b428b547bd39ccb6", "reference": "b6f544a20f4807e81f7044d31e679ccbb1866dc3",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -245,7 +245,7 @@
"cache", "cache",
"caching" "caching"
], ],
"time": "2015-12-31 16:37:02" "time": "2016-10-29 11:16:17"
}, },
{ {
"name": "erusev/parsedown", "name": "erusev/parsedown",
@ -554,16 +554,16 @@
}, },
{ {
"name": "silverstripe/docsviewer", "name": "silverstripe/docsviewer",
"version": "dev-master", "version": "2.0.0-beta4",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/silverstripe/silverstripe-docsviewer.git", "url": "https://github.com/silverstripe/silverstripe-docsviewer.git",
"reference": "9d7a1f621049980167a5a3ba4e7b418a62ee55ee" "reference": "40d70a0b32f1ea63594238ab25aba9d9397416b7"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/silverstripe/silverstripe-docsviewer/zipball/9d7a1f621049980167a5a3ba4e7b418a62ee55ee", "url": "https://api.github.com/repos/silverstripe/silverstripe-docsviewer/zipball/40d70a0b32f1ea63594238ab25aba9d9397416b7",
"reference": "9d7a1f621049980167a5a3ba4e7b418a62ee55ee", "reference": "40d70a0b32f1ea63594238ab25aba9d9397416b7",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -591,7 +591,7 @@
"documentation", "documentation",
"silverstripe" "silverstripe"
], ],
"time": "2016-11-07 13:31:41" "time": "2016-12-04 21:22:45"
}, },
{ {
"name": "silverstripe/dynamodb", "name": "silverstripe/dynamodb",
@ -636,16 +636,16 @@
}, },
{ {
"name": "silverstripe/framework", "name": "silverstripe/framework",
"version": "3.4.1", "version": "3.5.0",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/silverstripe/silverstripe-framework.git", "url": "https://github.com/silverstripe/silverstripe-framework.git",
"reference": "1f06e6dd18419cda02d58a78f39f6613c067a3ed" "reference": "179996b5f9ccbaab8882cafbf16c389623521b72"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/silverstripe/silverstripe-framework/zipball/1f06e6dd18419cda02d58a78f39f6613c067a3ed", "url": "https://api.github.com/repos/silverstripe/silverstripe-framework/zipball/179996b5f9ccbaab8882cafbf16c389623521b72",
"reference": "1f06e6dd18419cda02d58a78f39f6613c067a3ed", "reference": "179996b5f9ccbaab8882cafbf16c389623521b72",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -656,6 +656,11 @@
"phpunit/phpunit": "~3.7" "phpunit/phpunit": "~3.7"
}, },
"type": "silverstripe-module", "type": "silverstripe-module",
"extra": {
"branch-alias": {
"3.x-dev": "3.5.x-dev"
}
},
"autoload": { "autoload": {
"classmap": [ "classmap": [
"tests/behat/features/bootstrap" "tests/behat/features/bootstrap"
@ -681,7 +686,7 @@
"framework", "framework",
"silverstripe" "silverstripe"
], ],
"time": "2016-08-15 06:29:38" "time": "2016-11-28 12:35:19"
}, },
{ {
"name": "silverstripe/toolbar", "name": "silverstripe/toolbar",
@ -729,16 +734,16 @@
}, },
{ {
"name": "symfony/event-dispatcher", "name": "symfony/event-dispatcher",
"version": "v2.8.12", "version": "v2.8.14",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/symfony/event-dispatcher.git", "url": "https://github.com/symfony/event-dispatcher.git",
"reference": "889983a79a043dfda68f38c38b6dba092dd49cd8" "reference": "25c576abd4e0f212e678fe8b2bd9a9a98c7ea934"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/symfony/event-dispatcher/zipball/889983a79a043dfda68f38c38b6dba092dd49cd8", "url": "https://api.github.com/repos/symfony/event-dispatcher/zipball/25c576abd4e0f212e678fe8b2bd9a9a98c7ea934",
"reference": "889983a79a043dfda68f38c38b6dba092dd49cd8", "reference": "25c576abd4e0f212e678fe8b2bd9a9a98c7ea934",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -785,7 +790,7 @@
], ],
"description": "Symfony EventDispatcher Component", "description": "Symfony EventDispatcher Component",
"homepage": "https://symfony.com", "homepage": "https://symfony.com",
"time": "2016-07-28 16:56:28" "time": "2016-10-13 01:43:15"
}, },
{ {
"name": "unclecheese/display-logic", "name": "unclecheese/display-logic",
@ -896,16 +901,16 @@
}, },
{ {
"name": "phpunit/php-file-iterator", "name": "phpunit/php-file-iterator",
"version": "1.4.1", "version": "1.4.2",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/sebastianbergmann/php-file-iterator.git", "url": "https://github.com/sebastianbergmann/php-file-iterator.git",
"reference": "6150bf2c35d3fc379e50c7602b75caceaa39dbf0" "reference": "3cc8f69b3028d0f96a9078e6295d86e9bf019be5"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/6150bf2c35d3fc379e50c7602b75caceaa39dbf0", "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/3cc8f69b3028d0f96a9078e6295d86e9bf019be5",
"reference": "6150bf2c35d3fc379e50c7602b75caceaa39dbf0", "reference": "3cc8f69b3028d0f96a9078e6295d86e9bf019be5",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -939,7 +944,7 @@
"filesystem", "filesystem",
"iterator" "iterator"
], ],
"time": "2015-06-21 13:08:43" "time": "2016-10-03 07:40:28"
}, },
{ {
"name": "phpunit/php-text-template", "name": "phpunit/php-text-template",
@ -1200,16 +1205,16 @@
}, },
{ {
"name": "symfony/yaml", "name": "symfony/yaml",
"version": "v2.8.12", "version": "v2.8.14",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/symfony/yaml.git", "url": "https://github.com/symfony/yaml.git",
"reference": "e7540734bad981fe59f8ef14b6fc194ae9df8d9c" "reference": "befb26a3713c97af90d25dd12e75621ef14d91ff"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/symfony/yaml/zipball/e7540734bad981fe59f8ef14b6fc194ae9df8d9c", "url": "https://api.github.com/repos/symfony/yaml/zipball/befb26a3713c97af90d25dd12e75621ef14d91ff",
"reference": "e7540734bad981fe59f8ef14b6fc194ae9df8d9c", "reference": "befb26a3713c97af90d25dd12e75621ef14d91ff",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -1245,13 +1250,13 @@
], ],
"description": "Symfony Yaml Component", "description": "Symfony Yaml Component",
"homepage": "https://symfony.com", "homepage": "https://symfony.com",
"time": "2016-09-02 01:57:56" "time": "2016-11-14 16:15:57"
} }
], ],
"aliases": [], "aliases": [],
"minimum-stability": "dev", "minimum-stability": "dev",
"stability-flags": { "stability-flags": {
"silverstripe/docsviewer": 20, "silverstripe/docsviewer": 10,
"phpunit/phpunit": 0 "phpunit/phpunit": 0
}, },
"prefer-stable": true, "prefer-stable": true,

14
themes/docs/templates/Includes/DocumentationVersions.ss vendored
View File

@ -1,17 +1,21 @@
<% if Versions %> <% if $Versions %>
<div class="versions-heading">Versions:</div> <div class="versions-heading">Versions:</div>
<div class="versions"> <div class="versions">
<ul> <ul>
<% loop Versions.sort("Title DESC").limit(4) %> <% loop $Versions.sort("Title DESC") %>
<li><a href="$Link" class="$LinkingMode">$Title<% if $IsStable %> (stable)<% end_if %></a></li> <% if not $Archived %>
<li><a href="$Link" class="$LinkingMode">$Title<% if $IsStable %> (stable)<% end_if %></a></li>
<% end_if %>
<% end_loop %> <% end_loop %>
</ul> </ul>
</div> </div>
<form id="VersionsArchive"> <form id="VersionsArchive">
<select id="VersionSelect" onchange="location.href=VersionsArchive.VersionSelect.options[selectedIndex].value"> <select id="VersionSelect" onchange="location.href=VersionsArchive.VersionSelect.options[selectedIndex].value">
<option>Archived versions</option> <option>Archived versions</option>
<% loop Versions.sort("Title DESC").limit(20, 4) %> <% loop $Versions.sort("Title DESC").limit(20) %>
<option value="$Link">$Title</option> <% if $Archived %>
<option value="$Link">$Title</option>
<% end_if %>
<% end_loop %> <% end_loop %>
</select> </select>
</form> </form>