Skip to content
This repository has been archived by the owner on Oct 8, 2020. It is now read-only.

Docs for CiviReport outputhandlers #834

Merged
merged 2 commits into from
Aug 4, 2020

Conversation

demeritcowboy
Copy link
Contributor

@homotechsual
Copy link
Contributor

Tag me for review when you're ready.

@demeritcowboy demeritcowboy force-pushed the outputhandlers branch 2 times, most recently from c4d900f to 2ed7177 Compare July 22, 2020 14:58
@demeritcowboy demeritcowboy changed the title [WIP] Docs for CiviReport outputhandlers Docs for CiviReport outputhandlers Jul 22, 2020
@demeritcowboy
Copy link
Contributor Author

demeritcowboy commented Jul 22, 2020

I think it's ready now.

I wasn't sure about the last line, or even if including it whether that lab space is where it should live.

As an aside I was able to get mkdocs installed for previewing, but the only way I could get php code hiliting to work was with the 3 backticks and specifying php, otherwise no matter I did it seemed to be random hiliting or for a language I didn't recognize, possibly turtle-logo 🐢 .

Also this would be for civi 5.29.

@seamuslee001
Copy link
Collaborator

Looks good from my end @MikeyMJCO

@homotechsual
Copy link
Contributor

A few brief comments from the linting pass :-) looks good otherwise!

@demeritcowboy
Copy link
Contributor Author

Thanks updated as per feedback. So this is awaiting release 5.29.

@mlutfy
Copy link
Member

mlutfy commented Aug 4, 2020

@MikeyMJCO Just curious: why are you not merging?

@demeritcowboy
Copy link
Contributor Author

It's an interesting point that technically the feature is available to developers now if they're developing against master. I was mistakenly thinking along the lines of end-user features which are more tied to release numbers. So maybe a more general question is should there be a standard in the dev docs for identifying what versions a feature is available or discontinued. Maybe there is one and I'm not aware of it, or I just need to add some text in the docs somewhere "Added in 5.29"?

@mattwire
Copy link
Contributor

mattwire commented Aug 4, 2020

@demeritcowboy I'd really like to see somewhere a developer orientated list of added/removed/modified per version so you can easily track what version supports what. But it's probably a lot of work..

@homotechsual
Copy link
Contributor

@demeritcowboy I'd really like to see somewhere a developer orientated list of added/removed/modified per version so you can easily track what version supports what. But it's probably a lot of work..

It will be supported soon via meta-data embedded into the docs. The truth really is that I forget which book I'm looking at PRs for and assign to milestones incorrectly :-p

Merging :-)

@homotechsual homotechsual merged commit a824ddc into civicrm:master Aug 4, 2020
@demeritcowboy demeritcowboy deleted the outputhandlers branch August 4, 2020 15:09
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants