1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-09-10 14:56:06 +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

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