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

Reorganise "Email" part of guide -draft issue -not complete #260

Open
joannechester opened this issue Mar 22, 2018 · 2 comments
Open

Reorganise "Email" part of guide -draft issue -not complete #260

joannechester opened this issue Mar 22, 2018 · 2 comments
Assignees

Comments

@joannechester
Copy link
Contributor

The existing Email part (sounds odd, but seems to be the terminolgy I should use according to the style guide) is not laid out logically. It opens with a chapter called What is Civimail? when there is so much more to emailing than CiviMail.

This is something that would benefit from a brainstorming session at a residential sprint, but perhaps it can be sorted out via this issue. I propose the following re-arrangement of exisitng content and addition of new content in the email chapter.

  • Overview (open to suggestion for a better title) new content including:

In CiviCRM you can choose to:
• Send receipts automatically after an online transaction (monetary or otherwise) (system workflow messages)
• Schedule emails to be sent to individuals when something you have specified happens (scheduled reminders)
• Send emails individually or to groups of up to 50 contacts (Email - send now action)
• Send out eDMs and other mass emailings to thousands of contacts (CiviMail)

  • System workflow messages - new content and Modifying System Workflow Message Templates

  • Scheduled reminders - existing chapter

  • Email - send now to individuals or to groups of up to 50 contacts - exisiting chapter Everyday tasks

  • Mass mailings using CiviMail - existing chapter plus CiviMail A/B Testing

  • Message templates - (remains of) existing chapter

  • Maintaining Healthy Email Lists - existing chapter

  • Reports and analysis - existing chapter

@joannechester joannechester self-assigned this Mar 22, 2018
@seancolsen
Copy link
Contributor

I like this! To build on your plan, I'll offer some additional suggestions.

  • Change the page title "Email" to "Small emails" to make it more specific
  • Change the page title "Overview" to "Email". This way the reader will see "Email", click to expand, and see "Email" again right below it. Yes, in a way, that's kind of weird and redundant. But overall, I think it's actually a good way to organize content, especially because it allows us to use an index.md file for the page which simplifies the URL. Here's an example of this strategy in action: https://docs.civicrm.org/sysadmin/en/latest/upgrade/ Further, MkDocs has a bit of a limitation in that menu entries must be the same as page titles. Thus, to make the pages google-friendly, we kind of need to use more descriptive menu entries. For example, right now we have a lot of pages titled "What You Need To Know". These pages are harder for people to find on Google, and also harder for people to distinguish between if they have multiple tabs open in their browser.

Side note:

  • I agree that the word "part" is awkward, as you mention. I made this PR to fix it.

@github-actions
Copy link

This issue has had no activity in 60 days and has been marked as stale, it will be closed in 10 days.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants