add financial/overview (WIP waiting on Rich)

Created by: JoeMurray

Created by: artfulrobot

@JoeMurray I edited your repo:

1. adding markdown's required blank lines before lists.
2. adding a brief definition of financial type

Created by: artfulrobot

@MikeyMJCO thanks for the linting changes (slaps own wrist)! This page is still WIP and under discussion and subject to frequent changes, especially the code bits, so it might be better to hold off for a bit on that level. At least until I get that auto linting vim plugin up and running :-)

Created by: eileenmcnaughton

@artfulrobot @JoeMurray now the sprint is over I vote we merge & then we can continue to tweak - unless anything blocking it outstanding?

@artfulrobot @JoeMurray now the sprint is over I vote we merge & then we can continue to tweak - unless anything blocking it outstanding?

I agree with this - better to merge something slightly incomplete (we can add a notice!) than have nothing useful at all!

Created by: artfulrobot

Yeah, ok, I guess we get this up, but I feel the documentation is bridging the spec and the API we have and trying to pull them together.

e.g. there's also this (sent via mm but I think it got lost)

@JoeMurray Hope you enjoyed your day in Barcelona today! I'm on the train and doing a bit more on the Order API. I've found the bit on the original wiki "I believe (strongly) that status_id should NOT be a possible param for create - it should always be pending - with separate actions to change that - like add_payment." - think that was written by you? The actual behaviour is that if you omit "status_id": "Pending from incomplete transaction" from the params then the participant is created as Registered even while the contribution is still pending. Do you want to submit an issue for this?

@artfulrobot if there are actual blockers we should hold off until they are resolved - otherwise perhaps we merge it with appropriate caveats.

@artfulrobot Please add a "caveat" at the top as we're playing catch up in core / docs and there will need to be further tweaks to both. But better in than out now.

I'd go with:

!!! abstract
    This area of CiviCRM code and documentation is a work-in-progress. Not all features
    will be documented and the core code underlying this area may change from version
    to version.

Created by: eileenmcnaughton

@MikeyMJCO Can we merge this & then add that? (I have no merge rights on the repo for good reason)

Yep!

Done with #697