mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2025-04-02 08:46:56 +00:00
Docs updates for TW5's new branch development model
This commit is contained in:
parent
52a30be7c6
commit
273768da1d
8
editions/dev/tiddlers/Continuous Deployment.tid
Normal file
8
editions/dev/tiddlers/Continuous Deployment.tid
Normal file
@ -0,0 +1,8 @@
|
||||
created: 20190115173727727
|
||||
modified: 20190115173903645
|
||||
title: Continuous Deployment
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
TiddlyWiki 5 uses [[Travis CI|https://travis-ci.org/]] for continuous deployment. It is driven by the `.travis.yml` file in the root of the repo, along with the scripts in the `bin` folder that it invokes.
|
||||
|
||||
The build history can be seen at https://travis-ci.org/Jermolene/TiddlyWiki5
|
11
editions/dev/tiddlers/GitHub Branches.tid
Normal file
11
editions/dev/tiddlers/GitHub Branches.tid
Normal file
@ -0,0 +1,11 @@
|
||||
created: 20190115173458112
|
||||
modified: 20190115173645658
|
||||
title: GitHub Branches
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
Development of TiddlyWiki 5 in the GitHub repo at https://github.com/Jermolene/TiddlyWiki5 uses two branches:
|
||||
|
||||
* `master` contains the latest version of the code, and is deployed to https://tiddlywiki.com/prerelease
|
||||
* `tiddlywiki-com` contains the latest version of the documentation, and is deployed to https://tiddlywiki.com/, built by the latest released version of TiddlyWiki
|
||||
|
||||
When preparing pull requests it is important to target the correct branch.
|
@ -1,10 +1,18 @@
|
||||
modified: 20141122200310516
|
||||
created: 20190115173333457
|
||||
modified: 20190115173723915
|
||||
tags: TableOfContents
|
||||
title: HelloThere
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
Welcome to the developer documentation for TiddlyWiki (https://tiddlywiki.com/). It is currently a work in progress as material from two different sources is adapted and merged in addition to original content being added:
|
||||
|
||||
* An assignment by Christian Jurke and Christian Heigele, two students working on their Master's degree in Information Technology at the Gießen University of Applied Sciences (Technische Hochschule Mittelhessen). Their work can be seen in the [[Introduction]] and the tiddlers that link from it.
|
||||
* New developer documentation
|
||||
** [[Continuous Deployment]]
|
||||
** [[GitHub Branches]]
|
||||
** HookMechanism
|
||||
** [[Using ES2016 for Writing Plugins]]
|
||||
** [[Adding Babel Polyfill to TiddlyWiki]]
|
||||
* The original developer documentation from https://tiddlywiki.com:
|
||||
** [[TiddlyWiki for Developers]]
|
||||
** [[TiddlyWiki Coding Style Guidelines]]
|
||||
@ -21,6 +29,4 @@ Welcome to the developer documentation for TiddlyWiki (https://tiddlywiki.com/).
|
||||
** [[Scripts for building tiddlywiki.com]]
|
||||
** SyncAdaptorModules
|
||||
** WidgetModules
|
||||
** WikiRuleModules
|
||||
*Original developer documentation
|
||||
** HookMechanism
|
||||
** WikiRuleModules
|
@ -1,5 +1,5 @@
|
||||
created: 20131101111400000
|
||||
modified: 20150630205715827
|
||||
modified: 20190115165616599
|
||||
tags: Community
|
||||
title: Contributing
|
||||
type: text/vnd.tiddlywiki
|
||||
@ -25,9 +25,8 @@ There are other ways to [[help TiddlyWiki|HelpingTiddlyWiki]] too.
|
||||
|
||||
//The CLA documents used for this project were created using [[Harmony Project Templates|http://www.harmonyagreements.org]]. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity".//
|
||||
|
||||
Remarks
|
||||
-------
|
||||
!! Remarks
|
||||
|
||||
**When not owning the copyright in the entire work of authorship**
|
||||
''If you do not own the copyright in the entire work of authorship'':
|
||||
|
||||
In this case, please clearly state so, since otherwise we assume that you are the legal copyright holder of the contributed work! Please provide links and additional information that clarify under which license the rest of the code is distributed.
|
||||
In this case, please clearly state so and provide links and any additional information that clarify under which license the rest of the code is distributed.
|
||||
|
@ -1,11 +1,13 @@
|
||||
created: 20140820151051019
|
||||
modified: 20150630205758258
|
||||
modified: 20190115165616599
|
||||
tags: Community
|
||||
title: Improving TiddlyWiki Documentation
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
Anyone can submit improvements to the TiddlyWiki documentation that appears on https://tiddlywiki.com. (For improvements to the core code a more complicated process must be used because of the need to test the changes both in the browser and under Node.js before submission).
|
||||
|
||||
<<.warning """If you already know GitHub, note that documentation updates must be directed to the `tiddlywiki-com` branch""">>
|
||||
|
||||
# Read and observe the [[Documentation Style Guide]]
|
||||
# Create an account on https://github.com if you don't already have one
|
||||
# If you haven't done so already, sign the [[Contributor License Agreement]] as described in [[Signing the Contributor License Agreement]]
|
||||
|
@ -1,5 +1,5 @@
|
||||
created: 20150630205653005
|
||||
modified: 20160617151534171
|
||||
modified: 20190115165616599
|
||||
tags:
|
||||
title: Signing the Contributor License Agreement
|
||||
type: text/vnd.tiddlywiki
|
||||
@ -9,6 +9,7 @@ Create a GitHub pull request to add your name to `cla-individual.md` or `cla-ent
|
||||
''step by step''
|
||||
|
||||
# Navigate to [[licenses/CLA-individual|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md]] or [[licenses/CLA-entity|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md]] according to whether you are signing as an individual or representative of an organisation
|
||||
# Ensure that the "branch" dropdown at the top left is set to `tiddlywiki-com`
|
||||
# Click the "edit" button at the top-right corner (clicking this button will fork the project so you can edit the file)
|
||||
# Add your name at the bottom
|
||||
#* eg: `Jeremy Ruston, @Jermolene, 2011/11/22`
|
||||
|
@ -3,7 +3,7 @@ tags: $:/tags/EditTemplate
|
||||
list-after: $:/core/ui/EditTemplate/title
|
||||
|
||||
\define makeGitHubLink()
|
||||
https://github.com/Jermolene/TiddlyWiki5/edit/master/editions/tw5.com/tiddlers/$(githubLink)$
|
||||
https://github.com/Jermolene/TiddlyWiki5/edit/tiddlywiki-com/editions/tw5.com/tiddlers/$(githubLink)$
|
||||
\end
|
||||
\define innerMakeGitHubLink(linkText)
|
||||
<$set name="githubLink" value={{$:/config/OriginalTiddlerPaths##$(draftOfTiddler)$}}>
|
||||
|
@ -13,7 +13,7 @@ https://tiddlywiki.com/static/$(title)$.html
|
||||
\end
|
||||
|
||||
\define github-link-base()
|
||||
https://github.com/Jermolene/TiddlyWiki5/blob/master/editions/tw5.com/tiddlers/$(title)$
|
||||
https://github.com/Jermolene/TiddlyWiki5/blob/tiddlywiki-com/editions/tw5.com/tiddlers/$(title)$
|
||||
\end
|
||||
|
||||
\define make-github-link()
|
||||
|
Loading…
x
Reference in New Issue
Block a user