@sgiehl opened this Pull Request on December 3rd 2020 Member

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 commented on December 4th 2020 Member

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

@diosmosis commented on December 11th 2020 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?

@diosmosis commented on December 15th 2020 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 commented on December 15th 2020 Member

Be great to do it as part of 4.1 👍

@diosmosis commented on December 31st 2020 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 commented on January 4th 2021 Member

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

This Pull Request was closed on January 5th 2021
Powered by GitHub Issue Mirror