Documentation

• 1: Examples
• 2: Core Tasks
• 2.1: Working with Ponycopters
• 3: Tutorials
• 4: Developer Guide
• 4.1: Documentation
• 4.2: Concepts
• 4.3: Github
• 4.4: Cloudflare
• 4.5: A2hosting
• 4.6: Wordpress
• 4.7: Docsy
• 4.8: References
• 5: Admin Guide
• 5.1: Wordpress
• 5.2: References
• 5.3: Membership
• 5.4: Newsletters
• 5.5: Events
• 5.6: Blogs
• 5.7: Email
• 5.8: Overview
• 6: User Guide
• 6.1: Overview
• 6.2: Getting Started
• 6.3: The Basics
• 6.3.1: Password Reset
• 6.3.2: Join
• 6.4: Guest Accounts
• 6.5: Members
• 6.5.1: Content Moderators
• 6.5.1.1: Page Content
• 6.5.1.2: Blog Content
• 6.5.1.3: Forum Content
• 6.5.2: Bloggers
• 6.5.3: Event Coordinators
• 6.6: References

1 - Examples

Do you have any example applications or code for your users in your repo or elsewhere? Link to your examples here.

2 - Core Tasks

Think about your project’s features and use cases. Use these to choose your core tasks. Each granular use case (enable x, configure y) should have a corresponding tasks page or tasks page section. Users should be able to quickly refer to your core tasks when they need to find out how to do one specific thing, rather than having to look for the instructions in a bigger tutorial or example. Think of your tasks pages as a cookbook with different procedures your users can combine to create something more substantial.

You can give each task a page, or you can group related tasks together in a page, such as tasks related to a particular feature. As well as grouping related tasks in single pages, you can also group task pages in nested folders with an index page as an overview, as seen in this example site. Or if you have a small docset like the Docsy User Guide with no Tutorials or Concepts pages, consider adding your feature-specific pages at the top level of your docs rather than in a Tasks section.

Each task should give the user

• The prerequisites for this task, if any (this can be specified at the top of a multi-task page if they’re the same for all the page’s tasks. “All these tasks assume that you understand….and that you have already….”).
• What this task accomplishes.
• Instructions for the task. If it involves editing a file, running a command, or writing code, provide code-formatted example snippets to show the user what to do! If there are multiple steps, provide them as a numbered list.
• If appropriate, links to related concept, tutorial, or example pages.

2.1 - Working with Ponycopters

This is the section landing page.

3 - Tutorials

Tutorials are complete worked examples made up of multiple tasks that guide the user through a relatively simple but realistic scenario: building an application that uses some of your project’s features, for example. If you have already created some Examples for your project you can base Tutorials on them. This section is optional. However, remember that although you may not need this section at first, having tutorials can be useful to help your users engage with your example code, especially if there are aspects that need more explanation than you can easily provide in code comments.

4 - Developer Guide

4.1 - Documentation

4.2 - Concepts

4.3 - Github

4.4 - Cloudflare

4.5 - A2hosting

4.6 - Wordpress

4.7 - Docsy

4.8 - References

5 - Admin Guide

5.1 - Wordpress

5.2 - References

5.3 - Membership

5.4 - Newsletters

5.5 - Events

5.6 - Blogs

5.7 - Email

Email Strategy

Email accounts will only be provided to the Carteret Board offices. The current office holder will be given access to the Inbox when they take office. Access to the Inbox will be transferred to the new office holder upon taking office. Only the current office holder is to have access to the Inbox. The current email addresses provided are as follows:

• President@carteretwriters.org
• veep@carteretwriters.org
• treasurer@carteretwriters.org
• secretary@carteretwriters.org

Email Policy

There is no expectation of privacy with any @carteretwriters.org email address. These inboxes are the property of Carteret Writers, Inc and should be treated as such. Access to the inbox(es) is a privilege associated with the office and expires when the individual no longer holds the office. Emails should not be deleted as they function as a public record and provide for continuity between office holders. Creation of additional @carteretwriters email addresses will be approved by the Carteret Board.

Email Matrix

This matrix should be updated with each change.

Created on: 01/01/2023

Updated on:

5.8 - Overview

6 - User Guide

6.1 - Overview

Who is a User

Everyone who accesses Carteret Writers is considered a user.

Visitors

Users who aren’t members are considered visitors and the information we will provide reflects this distinction. Information about joining will be prominent.

Members

Members hold a special status as a user. They will require additional information - or in some cases, more extensive information. The information for the most part is still publicly available, but it won’t mean much to visitors.

Administrators

Members that have taken on administrative reponsibilities will require unique information than other groups.

Board Members

Members with additional responsibilities for managing the organization are Board Members. Their responsibilities may vary, but as the person holding the position on the board may change, the information needs to be preserved and passed on.

Developers

Developers may or may not be members. They are responsible for the underlying technology used by Carteret Writers.

Additional Information

Additional information may be available in the Carteret Writers Forum.

6.2 - Getting Started

6.3 - The Basics

6.3.1 - Password Reset

Table of Contents

• Introduction
• Prerequisites
• Task 1: Send Password Reset
• Task 2: Check Email
• Task 3: Reset Password
• Task 4: Login With New Password
• Troubleshooting
• FAQ
• Resources
• Conclusion

Introduction

Everyone forgets their password every now and then. In aniticipation of that there is a process to restore the password.

Prerequisites

This is what you’ll need to accomplish these tasks:

• Access to the internet.
• Access to whatever email you use for Carteret Writers.
• A new password you’d like to set.

Task 1: Send Password Reset

Objective

Reset your password and login to Carteret Writers.

Step 1

Use the login link on https://carteretwriters.org or this link to go to the login page. Locate the “Lost your password” link and click on it.

Step 2

Enter your email address or username in the box provided and click the “Get New Password” button.

You will see a confirmation screen if all went well.

Task 2: Check Email

Check your email for the message that was just sent and click on the link. Take note of your username.

Task 3: Reset Password

A web browser will open and suggest a strong password. The regenerate button will suggest a different strong password. Either accept a suggestion or enter your the password of your choosing. Then click the “Save Password” button.

You will see a confirmation screen if all went well.

Task 4: Login With New Password

Login using the new password just set and either the email address or the username that was noted in the email.

You should be taken to your profile page on the Carteret Writers website.

Troubleshooting

As a user, there isn’t much in the way of troubleshooting that can be done. The best bet is to email Support and we can reset the password.

FAQ

No Information yet.

Resources

Wordpress Official Documentation can be found HERE

Conclusion

Forgetting your password can be scary, but with a little patience you should be able to recover on your own. If that proves to be a little too chalenging, no worries, just email support and we’ll get it sorted for you.

6.3.2 - Join

Join Process

Getting Started

To begin, open a web browser and go to https://carteretwriters.org/

1. Join Us

Click on the ‘Join Us’ menu item to begin.

2. Join Today

Click on the ‘Join Today’ button.

3. Terms and Conditions

Check the box to accept the Terms and Conditions, then click on the Paypal button.

4. Paypal Username

Enter your paypal username and click the ‘Next’ button.

5. Paypal Password

Enter your paypal password and click the ‘Login’ button.

6. Select Payment Method

Select the payment method to use and click on the ‘Complete Purchase’ button.

7. Confirmation Page

The browser window will redirect to a confirmation page. Payment is now complete.

8. Confirmation Email

A confirmation email will be sent to the email address associated withe the Paypal Account.

9. Complete Registration

The account is not created until the link found in the email with a subject line of ‘Compete Your Registration’. This link is only valid one time.

10. Carteret Writer Username and Password

Enter a username and password (must be entered twice) to be used on https://carteretwriters.org/

11. Available

The page will check that your username and email address are unique to the website. Check the two boxes next to accept the Terms and Conditions and agree to the Privacy Policy. Then click on the ‘Register’ button.

12. Success!!

You will land on a Success page if everything went well.

Getting Help

I problems are encountered, please send an email to support@carteretwriters.org and include:

1. On what step the problem surfaced.
2. The email address being used.
3. Any errors that displayed on the screen.

6.4 - Guest Accounts

6.5 - Members

6.5.1 - Content Moderators

6.5.1.1 - Page Content

6.5.1.2 - Blog Content

6.5.1.3 - Forum Content

6.5.2 - Bloggers

6.5.3 - Event Coordinators

6.6 - References