Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds missing report documentations #16878

Merged
merged 16 commits into from Jan 5, 2021
Merged

Adds missing report documentations #16878

merged 16 commits into from Jan 5, 2021

Conversation

sgiehl
Copy link
Member

@sgiehl sgiehl commented Dec 3, 2020

Description:

This also fixes an issue where the report documentation was not visible after switching to a related report.

fixes #16792

Review

  • Functional review done
  • Usability review done (is anything maybe unclear or think about anything that would cause people to reach out to support)
  • Security review done see checklist
  • Code review done
  • Tests were added if useful/possible
  • Reviewed for breaking changes
  • Developer changelog updated if needed
  • Documentation added if needed
  • Existing documentation updated if needed

@sgiehl sgiehl added the Pull Request WIP Indicates the current pull request is still work in progress and not ready yet for a review. label Dec 3, 2020
@sgiehl sgiehl added this to the 4.1.0 milestone Dec 3, 2020
@sgiehl
Copy link
Member Author

sgiehl commented Dec 4, 2020

Would be good if someone else could look through the documentations I've added and maybe improve them further. Didn't spent too much time on thinking of good descriptions.

Also some of the dynamically created reports currently don't have a documentation, like the custom dimension reports. Not sure if we should add one there as well.

And we need to check all our plugins as well maybe

@sgiehl sgiehl added Needs Review PRs that need a code review and removed Pull Request WIP Indicates the current pull request is still work in progress and not ready yet for a review. labels Dec 4, 2020
@sgiehl sgiehl marked this pull request as ready for review December 4, 2020 20:17
@diosmosis
Copy link
Member

@mattab maybe we could have Daniel, the person rewriting our technical guides, to look over these docs later? For now we could merge after checking for small errors, then they could look through the UI and make tweaks to the report documentation w/o having to look through code. What do you think?

Copy link
Member

@Findus23 Findus23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just some simple spellchecking

plugins/Goals/lang/en.json Outdated Show resolved Hide resolved
Co-authored-by: Lukas Winkler <git@lw1.at>
@diosmosis
Copy link
Member

I think spending time making the report docs perfect here is probably time ill-spent, so I'll do some quick checks for typos and create a new issue to revise the report docs in the future. If that must be done in 4.1, it can be prioritized there.

@tsteur
Copy link
Member

tsteur commented Dec 15, 2020

Be great to do it as part of 4.1 👍

@mattab mattab modified the milestones: 4.1.0, 4.2.0 Dec 21, 2020
@diosmosis
Copy link
Member

@sgiehl I made some revisions to some of the docs, can you check if they sound better to you? Feel free to revert any changes I made.

@sgiehl
Copy link
Member Author

sgiehl commented Jan 4, 2021

@diosmosis the changes look good. If noone else does one to take a look, it might be good to merge.

@diosmosis diosmosis merged commit da9c615 into 4.x-dev Jan 5, 2021
@diosmosis diosmosis deleted the reportdocumentations branch January 5, 2021 00:41
@mattab mattab added the not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org. label Jan 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Review PRs that need a code review not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Have a report description for every report
5 participants