anselm's simpler werc fork
git clone git://git.suckless.org/swerc
Log | Files | Refs | README

commit ea0d82835213d3a9149a768b1f395c333c45367d
parent a6b711bf9d6f3ca5d51a186da9e8ca772e3fcd0c
Author: Uriel <u@berlinblue.org>
Date:   Fri, 11 Jun 2010 04:28:22 +0000

Many documentation changes and updates.
sites/werc.cat-v.org/development/index.md | 12+++++-------
sites/werc.cat-v.org/development/roadmap.md | 34++++++++++++++++++++++++++--------
sites/werc.cat-v.org/development/todo.md | 37+++++++++++++++++++++++++++----------
3 files changed, 58 insertions(+), 25 deletions(-)

diff --git a/sites/werc.cat-v.org/development/index.md b/sites/werc.cat-v.org/development/index.md @@ -1,17 +1,15 @@ Werc Development ================ -The latest dev code is available in the werc-dev hg repo: http://hg.cat-v.org/werc-dev/ +The latest dev code is available in the werc mercurial repo: http://hg.cat-v.org/werc/ -Release Numbering ------------------ -Releases with an od 'dot-number' (eg., 1.1.x) are development releases, they are hosted in the `werc-dev` hg repo. +Version Numbering and Branching Rules +------------------------------------- -Releases with an even 'dot-number' (eg., 1.2.x) are stable releases, only receive bug fixes, they are hosted in the `werc` hg repo. - -Major non-backwards compatible changes are only made in major release numbers (eg., 2.0). +There is no such thing! Originally a convention similar to that of the Linux kernel was used, but it is easier to do incremental work on a single branch. +For radical or experimental changes the `werc-dev` branch might be used, but at the moment it is outdated. Bug reports, feature requests, bug fixes and other patches are all very welcome, just send them to the [werc9](http://groups.google.com/group/werc9) mailing list. diff --git a/sites/werc.cat-v.org/development/roadmap.md b/sites/werc.cat-v.org/development/roadmap.md @@ -1,9 +1,21 @@ Development Roadmap =================== -Werc 1.3.x +The versioning scheme is a mess, originally even minor version numbers were +supposed to be stable and odd ones development branches, but turns out that for +the most part it is easier to do incremental development instead of keeping +'dev' and 'stable' branches. + +A development branch might be added in the future if the changes are radical +enough and break backwards compatibility in some important way. For this the +deprecated and currently outdated `werc-dev` mercurial repo will be used. + + +Werc 1.5.x ---------- +Planed major changes in 1.5 + * Include required p9p binaries in standard distribution (or with some easy to deploy packaging). * New/rewritten css layout, perhaps using fluid960gs? * File upload support [*Code contributed by maht, needs integration*] @@ -11,14 +23,20 @@ Werc 1.3.x * More complete test suite. -Werc 1.2.x, current stable branch +Werc 1.4.x, current stable branch --------------------------------- -* Only bugfixes. +* Mostly bugfixes, documentation work, and minor improvements. + + +Werc 1.2.x, previous stable branch +---------------------------------- + +* Only security fixes. -Werc 1.1.x previous dev branch ------------------------------- +Werc 1.1.x dev branch +--------------------- * Convert all templates and pages to HTML 5. [*Done*] * Include new markdown implementation in pure awk by yuyis.[*Done*] @@ -27,10 +45,10 @@ Werc 1.1.x previous dev branch * Include test suite/site (also to be hosted at http://tst.cat-v.org) [*In Progress*] -Werc 1.0.x, previous stable branch ----------------------------------- +Werc 1.0.x +---------- -* Only security fixes. +* Abandoned, please upgrade. ----------------------------------------------------- diff --git a/sites/werc.cat-v.org/development/todo.md b/sites/werc.cat-v.org/development/todo.md @@ -1,6 +1,13 @@ -Plans and ideas for the future +Plans and Ideas for the Future ============================== +This page lists various assorted ideas and features that have been proposed at +some point or another, nothing (except fixing the listed bugs) is assured to be +implemented, many things here might turn out to be bad ideas. + +Features +-------- + * Review ideas from: http://www.w3.org/TR/chips/ and http://www.w3.org/Provider/Style/URI and see if we can do better. * Canonize and redirect all requests, we already do this for things like missing or trailing /, should do the same for /. and /./, etc. Deleting trailing . and , should make pasted urls in emails work as links (**Mostly done in RC1**) * Blog: @@ -12,13 +19,14 @@ Plans and ideas for the future * Layout improvements: * Need to find a way to rig the order of items in the sidebar. * Right sidebar. + * Top+left/right nav vars (breadcrumbs at the top, current dir listing on the side) * Make it easier to disable all sidebars and headers/footers, eg., for full screen mode. * More testing and optimizations for mobile browsers, eg., http://www.operamini.com/demo/ Left sidebar had some minor issues in cellphones at some point. -* Better page titles (include whole path hierarchy?) +* Better page titles (include whole path hierarchy?) (**Partially done, is it good enough now?**) * Allow utf-8 characters in path elements (need to make sure this is safe, and not sure how useful it will be) * General code: - * Write a regression test suite - * Replace all references to non p9p/p9 programs (done?) + * Write a regression test suite. (*Started*) + * Replace all references to non p9p/p9 programs (*Done?*) * Document better the 'API' for sub-apps, both a set of environment vars apps can rely on (and in some cases set) and functions they can call (WIP). * Better generation of descriptive HTML META tags, eg.,: {META name="description" content="This is the Google Summer of Code blog for Plan9 and Inferno projects."} {META name="keywords" content="google, summer of code, inferno, plan9, programming"} * Should add werc to certain wikipedia lists: @@ -28,13 +36,13 @@ Plans and ideas for the future * Mathematic pseudo-CAPTCHA ala WP's 'Math Comment Spam Protection Plugin'. -Future plans ------------- +Future Plansi and Blue Sky +-------------------------- -* Wanted apps: +* Wanted [apps](/apps/): * Tagging, eg., append to _werc/tags * Related links sidebar generation. - * Bug/issue tracking app. + * [Bug/issue tracking app](/apps/gregor/). * Hg/git repository browser. * Implement AtomPub. @@ -42,7 +50,7 @@ Future plans * A way to wrap external cgi applications (eg., existing hg/git browser) * A way to generate static sites (ie., use werc as an offline templating system) * [9P](http://9p.cat-v.org) interface. -* New (simplified) markdown implementation, ideally in C or awk (maybe smu/libsmu by gottox?): +* New (simplified) markdown implementation, ideally in C or awk (maybe smu/libsmu by gottox?), yiyus great md2html.awk is a great start! * Simplified * Tables * Images @@ -50,9 +58,18 @@ Future plans * No inline html -Known bugs +Known Bugs ---------- +* It seems that certain chars are not propely encoded in cookies, possibly broken chars: :&%[+ Fix should go in cgilib.rc^set_cookie (Have to figure out the proper way to scape cookie strings first) +* If a dir under apps/ doesn't contain an app.rc file, werc fails to start. A possible fix would be to replace $werc_apps default with `apps/*/app.rc` instead of `apps/*/`, this would be backwards incompatible, but I doubt anyone uses that option. +* Links in Blagh feeds become confused if markdown 'references' are used, markdown references suck, but I guess we need to address this somehow... +* Somewhat similarly to the abouve, relative urls in imgs, links, etc. can easily break when used in Blagh posts, so it is not all markdown's fault. + + +Fixed or WFM Bugs +----------------- + * Sitemap can handle $dirfilter inconsistently from other places (**fixed**). * Finding directories that are inaccessible (-rx) can generate an infinite loop (**Works for me? Fixed with new menu code?**) * Some cat-v.org bits still left over here and there, should make them configurable (1.0 blocker) (**fixed**?)