1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-24 00:50:28 +00:00

Move developer docs into their own separate wiki

Will be served at http://five.tiddlywiki.com/dev/
This commit is contained in:
Jermolene 2013-11-27 10:27:57 +00:00
parent 3a9dc1a36d
commit f534d98e8b
33 changed files with 96 additions and 103 deletions

32
bld.cmd
View File

@ -16,18 +16,19 @@ if not exist %TW5_BUILD_OUTPUT%\nul (
echo Using TW5_BUILD_OUTPUT as %TW5_BUILD_OUTPUT%
echo.
rem Create the `static` directory if necessary
rem Create the `static` and `dev` directories if necessary
setlocal enableextensions
mkdir %TW5_BUILD_OUTPUT%\static
mkdir %TW5_BUILD_OUTPUT%\dev
mkdir %TW5_BUILD_OUTPUT%\dev\static
setlocal disableextensions
rem Delete any existing content
del /q /s %TW5_BUILD_OUTPUT%\static
rem First,
rem readme.md: the readme file for GitHub
rem First, the tw5.com wiki
rem index.html: the main file, including content
rem empty.html: the main file, excluding content
rem static.html: the static version of the default tiddlers
@ -35,8 +36,6 @@ rem static.html: the static version of the default tiddlers
node .\tiddlywiki.js ^
.\editions\tw5.com ^
--verbose ^
--rendertiddler ReadMe .\readme.md text/html ^
--rendertiddler ContributingTemplate .\contributing.md text/html ^
--rendertiddler $:/core/save/all %TW5_BUILD_OUTPUT%\index.html text/plain ^
--rendertiddler $:/editions/tw5.com/save-empty %TW5_BUILD_OUTPUT%\empty.html text/plain ^
--rendertiddler $:/core/templates/static.template.html %TW5_BUILD_OUTPUT%\static.html text/plain ^
@ -53,7 +52,20 @@ node .\tiddlywiki.js ^
--rendertiddler $:/core/save/all %TW5_BUILD_OUTPUT%\encrypted.html text/plain ^
|| exit 1
rem Third, tahoelafs.html: empty wiki with plugin for Tahoe-LAFS
rem Third, dev.html: developer info wiki
node .\tiddlywiki.js ^
.\editions\dev ^
--verbose ^
--rendertiddler ReadMe .\readme.md text/html ^
--rendertiddler ContributingTemplate .\contributing.md text/html ^
--rendertiddler $:/core/save/all %TW5_BUILD_OUTPUT%\dev\index.html text/plain ^
--rendertiddler $:/core/templates/static.template.html %TW5_BUILD_OUTPUT%\dev\static.html text/plain ^
--rendertiddler $:/core/templates/static.template.css %TW5_BUILD_OUTPUT%\dev\static\static.css text/plain ^
--rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html %TW5_BUILD_OUTPUT%\dev\static text/plain ^
|| exit 1
rem Fourth, tahoelafs.html: empty wiki with plugin for Tahoe-LAFS
node .\tiddlywiki.js ^
.\editions\tahoelafs ^
@ -61,7 +73,7 @@ node .\tiddlywiki.js ^
--rendertiddler $:/core/save/all %TW5_BUILD_OUTPUT%\tahoelafs.html text/plain ^
|| exit 1
rem Fourth, d3demo.html: wiki to demo d3 plugin
rem Fifth, d3demo.html: wiki to demo d3 plugin
node .\tiddlywiki.js ^
.\editions\d3demo ^
@ -69,7 +81,7 @@ node .\tiddlywiki.js ^
--rendertiddler $:/core/save/all %TW5_BUILD_OUTPUT%\d3demo.html text/plain ^
|| exit 1
rem Fifth, codemirrordemo.html: wiki to demo codemirror plugin
rem Sixth, codemirrordemo.html: wiki to demo codemirror plugin
node .\tiddlywiki.js ^
.\editions\codemirrordemo ^
@ -77,7 +89,7 @@ node .\tiddlywiki.js ^
--rendertiddler $:/core/save/all %TW5_BUILD_OUTPUT%\codemirrordemo.html text/plain ^
|| exit 1
rem Sixth, codemirrordemo.html: wiki to demo codemirror plugin
rem Seventh, codemirrordemo.html: wiki to demo codemirror plugin
node .\tiddlywiki.js ^
.\editions\markdowndemo ^
@ -90,6 +102,6 @@ rem Make the CNAME file that GitHub Pages requires
echo five.tiddlywiki.com > %TW5_BUILD_OUTPUT%\CNAME
rem Seventh, run the test edition to run the Node.js tests and to generate test.html for tests in the browser
rem Eighth, run the test edition to run the Node.js tests and to generate test.html for tests in the browser
.\test.cmd

32
bld.sh
View File

@ -19,16 +19,17 @@ echo "Using TW5_BUILD_OUTPUT as [$TW5_BUILD_OUTPUT]"
echo "five.tiddlywiki.com" > $TW5_BUILD_OUTPUT/CNAME
# Create the `static` directory if necessary
# Create the `static` and `dev` directories if necessary
mkdir -p $TW5_BUILD_OUTPUT/static
mkdir -p $TW5_BUILD_OUTPUT/dev
mkdir -p $TW5_BUILD_OUTPUT/dev/static
# Delete any existing content
rm $TW5_BUILD_OUTPUT/static/*
# First,
# readme.md: the readme file for GitHub
# First, the tw5.com wiki
# index.html: the main file, including content
# empty.html: the main file, excluding content
# static.html: the static version of the default tiddlers
@ -36,8 +37,6 @@ rm $TW5_BUILD_OUTPUT/static/*
node ./tiddlywiki.js \
./editions/tw5.com \
--verbose \
--rendertiddler ReadMe ./readme.md text/html \
--rendertiddler ContributingTemplate ./contributing.md text/html \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/index.html text/plain \
--rendertiddler $:/editions/tw5.com/save-empty $TW5_BUILD_OUTPUT/empty.html text/plain \
--rendertiddler $:/core/templates/static.template.html $TW5_BUILD_OUTPUT/static.html text/plain \
@ -54,7 +53,20 @@ node ./tiddlywiki.js \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/encrypted.html text/plain \
|| exit 1
# Third, tahoelafs.html: empty wiki with plugin for Tahoe-LAFS
# Third, dev.html: developer info wiki
node ./tiddlywiki.js \
./editions/dev \
--verbose \
--rendertiddler ReadMe ./readme.md text/html \
--rendertiddler ContributingTemplate ./contributing.md text/html \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/dev/index.html text/plain \
--rendertiddler $:/core/templates/static.template.html $TW5_BUILD_OUTPUT/dev/static.html text/plain \
--rendertiddler $:/core/templates/static.template.css $TW5_BUILD_OUTPUT/dev/static/static.css text/plain \
--rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html $TW5_BUILD_OUTPUT/dev/static text/plain \
|| exit 1
# Fourth, tahoelafs.html: empty wiki with plugin for Tahoe-LAFS
node ./tiddlywiki.js \
./editions/tahoelafs \
@ -62,7 +74,7 @@ node ./tiddlywiki.js \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/tahoelafs.html text/plain \
|| exit 1
# Fourth, d3demo.html: wiki to demo d3 plugin
# Fifth, d3demo.html: wiki to demo d3 plugin
node ./tiddlywiki.js \
./editions/d3demo \
@ -70,7 +82,7 @@ node ./tiddlywiki.js \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/d3demo.html text/plain \
|| exit 1
# Fifth, codemirrordemo.html: wiki to demo codemirror plugin
# Sixth, codemirrordemo.html: wiki to demo codemirror plugin
node ./tiddlywiki.js \
./editions/codemirrordemo \
@ -78,7 +90,7 @@ node ./tiddlywiki.js \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/codemirrordemo.html text/plain \
|| exit 1
# Sixth, codemirrordemo.html: wiki to demo codemirror plugin
# Seventh, codemirrordemo.html: wiki to demo codemirror plugin
node ./tiddlywiki.js \
./editions/markdowndemo \
@ -86,6 +98,6 @@ node ./tiddlywiki.js \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/markdowndemo.html text/plain \
|| exit 1
# Seventh, run the test edition to run the Node.js tests and to generate test.html for tests in the browser
# Eighth, run the test edition to run the Node.js tests and to generate test.html for tests in the browser
./test.sh

View File

@ -0,0 +1,24 @@
created: 20130822170200000
creator: JeremyRuston
modified: 20131126220042886
modifier: JeremyRuston
tags: introduction
title: HelloThere
type: text/vnd.tiddlywiki
This is the developer documentation hub for TiddlyWiki. For convenience, it also contains all of the end user documentation that appears at http://five.tiddlywiki.com/.
! Overview
* TiddlyWikiArchitecture
* [[TiddlyWiki5 Development Environment]]
* [[Building classic TiddlyWiki with TiddlyWiki5]]
! Developer Cookbooks
<$list filter="[tag[dev]tag[howto]sort[title]]"/>
! Internal Objects and Mechanisms
<$list filter="[tag[mechanism]sort[title]]"/>

View File

@ -0,0 +1,6 @@
title: $:/DefaultTiddlers
HelloThere
Resources
ReleaseHistory
RoadMap

View File

@ -0,0 +1,4 @@
title: SiteSubtitle
modifier: JeremyRuston
developer information for ~TiddlyWiki5

View File

@ -0,0 +1,4 @@
title: SiteTitle
modifier: JeremyRuston
five.tiddlywiki.com/dev

View File

@ -0,0 +1,13 @@
{
"plugins": [
"tiddlywiki/fullscreen",
"tiddlywiki/googleanalytics",
"tiddlywiki/github-fork-ribbon"
],
"themes": [
"tiddlywiki/snowwhite"
],
"includeWikis": [
"../tw5.com"
]
}

View File

@ -1,32 +0,0 @@
created: 201308251537
creator: JeremyRuston
modified: 201308260831
modifier: JeremyRuston
tags: introduction dev
title: DeveloperDocs
This is the developer documentation hub for TiddlyWiki.
! Overview
* TiddlyWikiArchitecture
* [[TiddlyWiki5 Development Environment]]
! Developer Cookbooks
<$list filter="[tag[dev]tag[howto]sort[title]]" type="ul"/>
! Internal Objects and Mechanisms
<$list filter="[tag[mechanism]sort[title]]" type="ul"/>
! Module types
!! SyncAdaptorModules
See SyncAdaptorModules.
!! DeserializerModules
Deserializers are modules that load tiddlers from different text formats:
<$list filter="[tag[deserializers]sort[title]]" type="ul"/>

View File

@ -1,48 +0,0 @@
created: 201308252217
creator: JeremyRuston
modified: 201308270750
modifier: JeremyRuston
tags: dev
title: Plan for moving from Alpha to Beta
! Goals for moving to Beta
To move from alpha to beta, TiddlyWiki5 needs a better release and deployment process. At a minimum:
* Each release should be automatically assigned a unique revision number, with a simple manual process to bump the major or minor version number
* Each release should be available as a zip download on GitHub and tiddlywiki.com
* Releases should be automatically pushed to NPM
* A release note for end users should be automatically generated from the commits
** The process should allow for manual editing of the release note
* A clear distinction between a new release of the TW5 core plugins and revised content for the tw5.com website
It would also be nice to have:
* Automatic tweets from @TiddlyWiki announcing each release
! Tasks for moving to Beta
!! Update https://github.com/Jermolene/tiddlywiki.com
This is the repository for the content and build tools for tiddlywiki.com, forked from https://github.com/TiddlyWiki/tiddlywiki.com. It needs updating to include both TW5 and TW classic, with a unified build and deployment process for the website. The content from `TiddlyWiki5/editions/tw5.com` would be moved here.
The pull request will be merged when we switch into beta. Until then, we'll build to http://jermolene.github.com, meaning that http://five.tiddlywiki.com will be a replica of tiddlywiki.com post-beta switchover.
The basic build process for tw5.com is:
Preparation
* Update the content and commit as needed
* Pull down the correct version of TW5 for the build
* Pull down the content repos
* Fork tiddlywiki.github.com and pull it down
Build cycle
* Run the build scripts
* Review pull request for tiddlywiki.github.com
Deployment
* Merge pull request on github.com

File diff suppressed because one or more lines are too long