mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 18:17:20 +00:00
Code Issues Releases Wiki Activity

More docs updates

Browse Source
This commit is contained in:
Jermolene 2014-09-10 22:35:02 +01:00
parent f781b2b8d0
commit a95bb2b6ec
12 changed files with 52 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
editions/tw5.com-server/tiddlers/config-Navigation-UpdateAddressBar.tid Normal file
View File

@ -0,0 +1,6 @@
created: 20140910212049455
title: $:/config/Navigation/UpdateAddressBar
type: text/vnd.tiddlywiki
note: <!-- TODO: Remove before end of beta -->
permaview

4
editions/tw5.com/tiddlers/howtos/Improving TiddlyWiki Documentation.tid → editions/tw5.com/tiddlers/Improving TiddlyWiki Documentation.tid
View File

@ -1,7 +1,7 @@
created: 20140820151051019
modified: 20140904165057207
modified: 20140910211458809
tags: Community
title: Improving TiddlyWiki documentation
title: Improving TiddlyWiki Documentation
type: text/vnd.tiddlywiki
Anyone can submit improvements to the TiddlyWiki documentation that appears on http://tiddlywiki.com.

7
editions/tw5.com/tiddlers/Reference.tid Normal file
View File

@ -0,0 +1,7 @@
caption: Complete Reference
created: 20140910212931897
modified: 20140910213038857
tags: TableOfContents
title: Reference
type: text/vnd.tiddlywiki

27
editions/tw5.com/tiddlers/community/Contributing.tid
View File

@ -1,36 +1,29 @@
created: 20131101111400000
modified: 20140607164329806
modified: 20140910211823607
tags: introduction Community
title: Contributing
type: text/vnd.tiddlywiki
TiddlyWiki5 welcomes contributions to its code and documentation via [[GitHub|https://github.com/Jermolene/TiddlyWiki5]]. Please take a moment to read these notes to help make the process as smooth as possible.
We welcome contributions to the code and documentation of TiddlyWiki in several ways:
!! Coding Style
* ReportingBugs
* Helping to [[improve our documentation|Improving TiddlyWiki Documentation]]
* Contributing to the code via [[GitHub|https://github.com/Jermolene/TiddlyWiki5]]
** See http://tiddlywiki.com/dev for more details
Code contributions should follow the [[TiddlyWiki Coding Style Guidelines]].
!! GitHub Issues
See ReportingBugs for information about how TiddlyWiki handles bug reports.
!! Contributor License Agreement
! Contributor License Agreement
Like other OpenSource projects, TiddlyWiki5 needs a signed contributor license agreement from individual contributors. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the UnaMesa Association (the legal entity that owns TiddlyWiki on behalf of the community).
* For individuals use: [[licenses/CLA-individual|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md]]
* For entities use: [[licenses/CLA-entity|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md]]
//This is a first pass at a CLA for TiddlyWiki. Please let us know if we missed something important. If we do have to make essential changes to the CLA, there is a possibility that all contributors will need to sign it again//
!!! How to sign the CLA
! How to sign the CLA
Create a GitHub pull request to add your name to `cla-individual.md` or `cla-entity.md`, with the date in the format (YYYY/MM/DD).
eg: `Jeremy Ruston, @Jermolene, 2011/11/22`
''Thank you!''
---
!!!! Attribution
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"
//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".//

4
editions/tw5.com/tiddlers/community/Groups.tid
View File

@ -1,10 +1,8 @@
title: Groups
title: TiddlyWiki Local Interest Groups
created: 20140721121924384
modified: 20140721121924384
tags: [[Get help and learn more]] Community
! Local ~TiddlyWiki Interest Groups
Local meetings of ~TiddlyWiki enthusiasts around the world:
* [[OXTWIG]], the ''Oxford ~TiddlyWiki Interest Group'' meets monthly in Oxford, UK to share experiences of using TiddlyWiki

6
editions/tw5.com/tiddlers/community/Report bugs.tid
View File

@ -1,6 +0,0 @@
title: Report bugs
tags: Community
created: 201409081236
modified: 201409081236
forthcoming...

17
editions/tw5.com/tiddlers/community/ReportingBugs.tid
View File

@ -1,15 +1,12 @@
created: 20140604204709181
modified: 20140604205253392
tags: tips
modified: 20140910212541960
tags: Community
title: ReportingBugs
type: text/vnd.tiddlywiki
There are two ways to report bugs in TiddlyWiki:
You can report bugs or problems with TiddlyWiki via our [[discussion groups|Forums]]. If you have a GitHub account then you can raise an issue there:
* via the TiddlyWiki discussion group (requires a Google account)
** http://groups.google.com/group/TiddlyWiki
* via the TiddlyWiki GitHub repository (requires a GitHub account)
** https://github.com/Jermolene/TiddlyWiki5/issues/new
https://github.com/Jermolene/TiddlyWiki5/issues/new
Unless you are already familiar with GitHub, it's usually easiest to report problems through the discussion groups.
@ -17,13 +14,13 @@ Unless you are already familiar with GitHub, it's usually easiest to report prob
We use GitHub Issues to manage bug reports and feature requests for TiddlyWiki. To maintain their effectiveness we endeavour to have as few open issues as possible.
!!! Policies for Managing Issues
!! Policies for Managing Issues
Open issues should be actionable: generally either a reproducible bug report, or a specific feature request. From the perspective of the core developers, the issues list behaves like a shared todo list. Every item on the list requires a little bit of attention each time we check the list.
GitHub Issues are not very good for managing ideas that are not immediately actionable. Better to use the [[TiddlyWiki discussion groups|Community]] for open ended questions, or speculative discussions of new features.
GitHub Issues are not very good for managing ideas that are not immediately actionable. Better to use the [[TiddlyWiki discussion groups|Forums]] for open ended questions, or speculative discussions of new features.
!!! Creating Issues
!! Creating Issues
Before creating a GitHub issue it is good etiquette to search through the existing issues to see whether the problem has already been reported. If a search isn't practical, don't worry too much; GitHub makes it easy to merge existing issues.

6
editions/tw5.com/tiddlers/community/Translate TW.tid
View File

@ -1,6 +0,0 @@
title: Translate TiddlyWiki into your language
tags: Community
created: 201409081238
modified: 201409081238
forthcoming...

7
editions/tw5.com/tiddlers/community/Translate TiddlyWiki into your language.tid Normal file
View File

@ -0,0 +1,7 @@
created: 20140908123800000
modified: 20140910212909125
tags: Community
title: Translate TiddlyWiki into your language
type: text/vnd.tiddlywiki
Our eventual goal is to make it easy for anyone to create a new translation for TiddlyWiki. Right now, the process requires familiarity with GitHub and so is documented over at http://tiddlywiki.com/dev.

11
editions/tw5.com/tiddlers/definitions/GitHub.tid Normal file
View File

@ -0,0 +1,11 @@
created: 20140910212609354
modified: 20140910212725412
tags: definitions
title: GitHub
type: text/vnd.tiddlywiki
GitHub is a commercial organisation that operates a service for hosting code that includes powerful collaborative features.
The code and documentation of TiddlyWiki is hosted on GitHub at:
https://github.com/Jermolene/TiddlyWiki5

2
editions/tw5.com/tiddlers/system/tw5.com-styles.tid
View File

@ -14,7 +14,7 @@ tags: $:/tags/Stylesheet
}
.tc-link-info-item {
max-width: 25em;
max-width: 24em;
margin-right: 10px;
}

5
editions/tw5.com/tiddlers/tocproject/TiddlyWiki glossaries.tid
View File

@ -1,5 +0,0 @@
title: TiddlyWiki glossaries
tags: TableOfContents
toc-link: no
created: 201409081158
modified: 201409081158