diff --git a/DEVELOPMENT.md b/DEVELOP.md similarity index 89% rename from DEVELOPMENT.md rename to DEVELOP.md index 5dcf8fbff..b2c4084ab 100644 --- a/DEVELOPMENT.md +++ b/DEVELOP.md @@ -1,19 +1,12 @@ --- -title: hledger contributor guide +title: hledger Developer Guide --- -# Contributor guide +# Developer guide ## Quick links -**Support**
- IRC channel: [irc.freenode.net/#ledger](irc://irc.freenode.net/#ledger)\ - Mail list: [hledger.org/list](http://hledger.org/list)\ - Bug tracker: [hledger.org/bugs](http://hledger.org/bugs)\ - Wishlist/planning: [hledger.org/plan](http://hledger.org/plan)\ - Code: [hledger.org/code](http://hledger.org/code) - -**Released version**
+**hledger released version**
[release notes](NEWS.html), [hledger-web demo](http://demo.hledger.org)
@@ -26,11 +19,11 @@ title: hledger contributor guide [hledger-lib](http://hackage.haskell.org/package/hledger-lib) packages -**Development version**
+**hledger development version**
[Get it](#how-to-set-up-for-hledger-development), [browse it](http://github.com/simonmichael/hledger), [changes](http://github.com/simonmichael/hledger/commits), - [CHANGES!](http://starlogs.net/#simonmichael/hledger) (turn up your volume first) + [CHANGES!](http://starlogs.net/#simonmichael/hledger) (turn up your volume)
[developer notes](http://github.com/simonmichael/hledger/NOTES.org), @@ -57,14 +50,31 @@ or ## How to.. -### how to get help +### how to report problems -- join and use the [hledger mail list](http://hledger.org/list) -- chat Simon (sm) on the - [\#ledger](irc://irc.freenode.net/#ledger) irc channel which we - share, or [send email](mailto:simon@joyful.com?subject=hledger:) -- for issues relevant to the wider *ledger community, you can also use or cc [ledger's mail list](http://list.ledger-cli.org) -- don't forget the [installation tips](MANUAL.html#installing), [Troubleshooting](MANUAL.html#troubleshooting) section, and [bug tracker](http://hledger.org/bugs) +- check for related issues in the [bug tracker](http://hledger.org/bugs) or in the [mail list archive](http://hledger.org/list) +- discuss/confirm the issue on irc or list +- report new issues in the bug tracker + + +### how to help with testing + +- review and test our documentation and web presence +- download and test the binaries on your platform +- test installing via cabal +- use the tools and test functionality, usability, browser compatibility, ui layout etc. +- check that `hledger test` reports no failures +- [run the developer tests](#how-to-run-the-tests) +- discuss/report problems via irc/mail list/bug tracker + +### how to help with bug tracking + +- get to know the [bug tracker](http://hledger.org/bugs) and its contents +- research and update issues +- some convenient url shortcuts: + [`hledger.org/bugs`](http://hledger.org/bugs) + [`hledger.org/bugs/new`](http://hledger.org/bugs/new) + `hledger.org/bugs/N` ### how to report problems diff --git a/DOCS.md b/DOCS.md index b56306afb..71e6418b2 100644 --- a/DOCS.md +++ b/DOCS.md @@ -13,7 +13,7 @@ title: hledger docs [0.19.x User Manual](0.19/MANUAL.html), [0.18.x User Manual](0.18/MANUAL.html)) -[Contributor Guide](DEVELOPMENT.html) *support, community and developer resources* +[Developer Guide](DEVELOP.html) [Compatibility with ledger](LEDGER.html) diff --git a/README.md b/README.md index b615cbcca..5816b0108 100644 --- a/README.md +++ b/README.md @@ -25,15 +25,16 @@ learn more, including [how we are different from ledger](FAQ.html#how-does-hledger-relate-to-ledger), and get started tracking your numbers! -**Quick links:** -Mail list: [hledger.org/list](http://hledger.org/list) -IRC channel: [irc.freenode.net/#ledger](irc://irc.freenode.net/#ledger) -Bug tracker: [hledger.org/bugs](http://hledger.org/bugs) -Wishlist/planning: [hledger.org/trello](http://hledger.org/trello) -Code: [hledger.org/code](http://hledger.org/code) +**Community** + +**IRC (chat):** [irc.freenode.net/#ledger](irc://irc.freenode.net/#ledger) (shared with ledger, I am "sm" there) +**Mail list:** [hledger.org/list](http://hledger.org/list). (or for general *ledger issues, you can use or cc [ledger's list](http://list.ledger-cli.org)) +**Bug tracker:** [hledger.org/bugs](http://hledger.org/bugs) +**Wishlist/planning:** [hledger.org/trello](http://hledger.org/trello) +**Code:** [hledger.org/code](http://hledger.org/code) +**Docs:** [Installation Guide](INSTALL.html), **[User Manual](MANUAL.html)**, [Release Notes](NEWS.html) and [more](DOCS.html). diff --git a/site/templates/default.html b/site/templates/default.html index f5d5fdc06..accb6afac 100644 --- a/site/templates/default.html +++ b/site/templates/default.html @@ -23,7 +23,7 @@ Home Download Docs - Contribute + Develop Wiki Demo