mirror of
https://github.com/simonmichael/hledger.git
synced 2024-09-19 10:17:35 +03:00
docs: reorganize front page/developer guide
This commit is contained in:
parent
e89bd131e9
commit
c24637fb57
@ -1,19 +1,12 @@
|
||||
---
|
||||
title: hledger contributor guide
|
||||
title: hledger Developer Guide
|
||||
---
|
||||
|
||||
# Contributor guide
|
||||
# Developer guide
|
||||
|
||||
## Quick links
|
||||
|
||||
**Support**<br>
|
||||
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**<br>
|
||||
**hledger released version**<br>
|
||||
[release notes](NEWS.html),
|
||||
[hledger-web demo](http://demo.hledger.org)
|
||||
<br>
|
||||
@ -26,11 +19,11 @@ title: hledger contributor guide
|
||||
[hledger-lib](http://hackage.haskell.org/package/hledger-lib)
|
||||
packages
|
||||
|
||||
**Development version**<br>
|
||||
**hledger development version**<br>
|
||||
[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)
|
||||
<!-- [hledger-web dev demo](http://demo.hledger.org:5001) -->
|
||||
<br>
|
||||
[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
|
||||
<!-- - test and share problem journal snippets at paste . hledger.org -->
|
||||
|
||||
### 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
|
||||
|
2
DOCS.md
2
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)
|
||||
|
||||
|
19
README.md
19
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).
|
||||
|
||||
<!--
|
||||
For support and more technical info, see the [contributor guide](DEVELOPMENT.html)
|
||||
or [email me](mailto:simon@joyful.com?subject=hledger:). I appreciate
|
||||
feedback and help with all aspects of hledger.
|
||||
or [email me](mailto:simon@joyful.com?subject=hledger:).
|
||||
I appreciate feedback and help with all aspects of hledger.
|
||||
-->
|
||||
|
@ -23,7 +23,7 @@
|
||||
<a href="/README.html">Home</a>
|
||||
<a href="/DOWNLOAD.html">Download</a>
|
||||
<a href="/DOCS.html">Docs</a>
|
||||
<a href="/DEVELOPMENT.html">Contribute</a>
|
||||
<a href="/DEVELOP.html">Develop</a>
|
||||
<a href="http://hledger.org/wiki" class="offsite">Wiki</a>
|
||||
<a href="http://demo.hledger.org" class="offsite">Demo</a>
|
||||
</div>
|
||||
|
Loading…
Reference in New Issue
Block a user