Update Analytics Report doc with sidebar UI by jonambas · Pull Request #659 · SparkPost/support-docs
Conversation
What Changed
- Updates the Analytics Report doc with the new sidebar UI. Updates only some of the images.
How To Test or Verify
- Visit
/docs/reporting/analytics-report/ - Verify the all images work and verify content makes sense 😄
PR Checklist
All PRs Checklist
- Give your pull request a meaningful name.
- Use lowercase filenames.
- Apply at least one team label according to which team is the content expert (ie.
team-FEorteam-SAZ) - Pull request approval from the FE team or content experts (see label applied above) that isn't the content creator.
Content Changes Checklist
- Check that your article looks correct in the preview here or in a Netlify deploy preview.
- Check the links in your article.
- Check the images in your article (if there are any)
- Check to make sure you are using markdown appropriately as outlined in
examples/article.mdin the root of the project directory and on the momentum doc's preface article - Check to make sure the Copy and Tone Guidelines are followed.
Development Changes Checklist (some checks are automatic github actions and will not be listed here. ie. "all tests pass")
- The appropriate tests are created in
cypress/directory in the root of the project - The lighthouse score is passing according to the FE Support Docs' Service Outline SLI/SLOs
|
|
||
| #### Favorite Reports | ||
|
|
||
| For quick and easy access to your reports, you can save them as favorites by clicking the dropdown menu next to the reports in the sidebar. |
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
May want to add "You can save both preset reports and reports you create as favorites." Also - is there a limit on favorites? If so, may want to add number of reports you can favorite. If there is no limit, I'm ok with just not mentioning a limit (leave the fact that it's unlimited undocumented) in case we add a limit later.
| #### Preset Reports | ||
|
|
||
| Your account comes with several preset saved reports which are available from the report dropdown. All preset reports are also available through a menu by clicking the “View All Reports” button in the upper right-hand corner. | ||
| Your account comes with several preset saved reports which are available from the sidebar. All preset reports are also available through a menu by clicking the All Reports” button at the bottom of the sidebar. |
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
consider adding that you can use a preset report as-is or use it as a starting point for a custom report which you can then save/edit. that might be obvious, I'm not sure 🤷
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters