diff options
Diffstat (limited to 'README.md')
l---------[-rw-r--r--] | README.md | 68 |
1 files changed, 1 insertions, 67 deletions
@@ -1,67 +1 @@ | |||
1 | --- | README \ No newline at end of file | |
2 | favicon: cartdave_favicon.png | ||
3 | pagetitle: "notYetAnotherWiki is not another wiki, at least not yet. It'll be much more than that, eventually." | ||
4 | author: onefang | ||
5 | feedatom: https://sledjhamr.org/cgit/notYetAnotherWiki/atom | ||
6 | history: https://sledjhamr.org/cgit/notYetAnotherWiki/log/index.md | ||
7 | sourcecode: https://sledjhamr.org/cgit/notYetAnotherWiki/ | ||
8 | --- | ||
9 | |||
10 | notYetAnotherWiki is not another wiki, at least not yet. It'll be much | ||
11 | more than that, eventually. | ||
12 | |||
13 | So to start with it's not a wiki. It's currently a way to create a web | ||
14 | site with CommonMark wiki markup, using git to update the content. | ||
15 | |||
16 | So it's not a wiki, yet. | ||
17 | |||
18 | Next comes accounts and online editing of content with the web pages. | ||
19 | It'll then barely be a wiki. | ||
20 | |||
21 | The missing bit is talk pages, which requires some sort of archiving chat | ||
22 | system built into the thing. Now it's Yet Another Wiki. | ||
23 | |||
24 | Finally comes the magic, so it's "not Yet Another Wiki", it's much more | ||
25 | than that. | ||
26 | |||
27 | A web forum is basically a web based chat system with archiving. We got | ||
28 | that now, we can just say it's a web forum as well. Just leave off the | ||
29 | wiki page bit. | ||
30 | |||
31 | Only difference between an instant messaging system and a web forum is | ||
32 | how fast it runs. So just make this fast, then we can call it an instant | ||
33 | messaging system. | ||
34 | |||
35 | Put email behind a web forum, you got a mailing list with a web archive. | ||
36 | |||
37 | An issue tracker is basically a wiki type page with the forum style | ||
38 | messages, and often an email control system. Only that last bit needs to | ||
39 | be added. | ||
40 | |||
41 | A lot of projects will put together all of these things to support their | ||
42 | users. Different systems, different accounts, same info. Too much "Oh, | ||
43 | that's in the forum somewhere" on the mailing list or whatever. | ||
44 | |||
45 | notYetAnotherWiki puts it all together as a single system, with multiple | ||
46 | ways of using it depending on what the users want, and ways of organising | ||
47 | the useful info that makes it's way into the system one way or another. | ||
48 | |||
49 | Someone comes into your chat system, asking for help, within minutes | ||
50 | people are helping out and come up with a working solution. After a few | ||
51 | other people turn up with the same problem, the existing conversations | ||
52 | are moved to the decumentation section, where the original participants | ||
53 | and others can polish it into proper documentation about solving what has | ||
54 | suddenly become a common problem. Every one knows where to find it, on | ||
55 | the one system. They can chat about it, on the one system. | ||
56 | |||
57 | ## What does it do already? | ||
58 | |||
59 | Currently it'll scan the current directory and subdirectories rooking for | ||
60 | .md files in CommonMark syntax. This should cover some MarkDown | ||
61 | variations. Then it produces .HTML files converted from these .md files, | ||
62 | and links them all together into a web site. | ||
63 | |||
64 | git is used to store the .md files, and provides edit history. Added on | ||
65 | the footer is links to cgit, which is used to store the files in git on | ||
66 | your server. This provides acces to the source code, history, and ATOM | ||
67 | feed for the site. | ||