Skip to content

Commit

Permalink
revamp squads docs post-GA (#448)
Browse files Browse the repository at this point in the history
  • Loading branch information
nimrodkra authored Nov 20, 2024
1 parent 8a3ae6a commit d49d0ef
Show file tree
Hide file tree
Showing 6 changed files with 230 additions and 92 deletions.
24 changes: 14 additions & 10 deletions docs/squads/creating-your-squad.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,25 @@ description: "Learn how to create your own developer-focused Squad on daily.dev.

## What is a Squad?

A Squad is a developer-focused group where members can come together to learn, interact, and engage on topics that matter to them. Think of Squads as tailored online groups specifically for developers. Squads facilitate knowledge sharing, discussions, and peer interactions, making them ideal for teams, projects, communities, or niche interests.
A Squad is a developer-focused group where members can come together to learn, interact, and engage on topics that matter to them. Think of Squads as tailored online communities specifically for developers. Squads facilitate knowledge sharing, discussions, and peer interactions, making them ideal for teams, projects, communities, or niche interests.

A Squad can be **Public** or **Private**:
- **Public Squads**: Featured in the Squad Directory and open for anyone to join.
- **Public Squads**: Open to all developers and discoverable in the Squad Directory. Public Squads enjoy additional benefits like wider exposure and being featured in categories.
- **Private Squads**: Invite-only, ensuring more controlled membership.

## Key Features of Squads

Squads offer several interactive features to create an engaging experience:

**Create a Squad**: Customize your Squad with a unique name, image, and description.
**Create a Squad**: Customize your Squad with a unique name, handle, image, description, and select a category for Public Squads.

**Invite Members**: Bring in developers you know to discuss, share resources, and collaborate. In Public Squads, adding moderators is recommended to manage conversations effectively.
**Invite Members**: Bring in developers to discuss, share resources, and collaborate.

**Post & Share Content**: Depending on settings, posting can be open to everyone or restricted to moderators. Share daily.dev links, external resources, and support discussions with full markdown compatibility.
**Post & Share Content**: Depending on settings, posting can be open to everyone or restricted to moderators. Enjoy full Markdown compatibility for rich discussions.

**Moderation Tools**: As an admin, you have tools to manage posts, comments, and member interactions, fostering a healthy and respectful environment.
**Moderation Tools**: As an admin, you have tools to manage posts, comments, and member interactions.

**Integrate with Work Tools**: Kickstart collaboration by integrating your Squad with work-related tools, such as Slack. This makes setup seamless and enables stronger team alignment.

## How to Create a Squad

Expand All @@ -35,17 +37,19 @@ Starting a Squad is easy. Follow these steps:
2. **Name Your Squad**: Choose a name and handle that captures the focus of your Squad.
3. **Add an Image**: Upload a profile image for your Squad, such as a logo or icon.
4. **Write a Description**: Explain the theme, objectives, and member expectations for your Squad.
5. **Select a Category** *(Public Squads Only)*: Choose a category that best fits your Squad from options like Languages, Web, AI, Career, and more.

:::tip
The most active Squads have engaged members. Encourage everyone to contribute, share, and discuss. With the tools provided by daily.dev, you’re set to build a valuable developer community.
The most active Squads have engaged members. Encourage contributions, discussions, and sharing. Leverage daily.dev’s netowrk to build a valuable developer community.
:::

## Squad Visibility: Private vs. Public

When creating a Squad, select the desired visibility:

1. **Private Squads**: Accessible only by invite, with content visible only to members.
2. **Public Squads** (default): Open and discoverable in the Directory, allowing developers to join freely.
3. **Featured Squads**: High-value Public Squads with strong engagement may become featured, gaining increased visibility.
2. **Public Squads**: Open and discoverable in the Squads Directory, allowing developers to join freely.

Public Squads must select a category during setup. Categories like Web, Mobile, AI, and Fun help users discover Squads that align with their interests.

Good luck! We can’t wait to see your community thrive ✨
Good luck! We can’t wait to see your community thrive ✨
71 changes: 59 additions & 12 deletions docs/squads/featured-squads.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,70 @@ description: "Learn how to get your Public Squad featured on the daily.dev Squad

![Squads Directory Feature](https://github.com/user-attachments/assets/fb28a405-1c0d-45f8-a8a2-6cfa278ce84e)

The [Public Squads Directory](https://app.daily.dev/squads) on daily.dev is a curated space where community members can discover new and engaging Public Squads. Being featured here significantly boosts your Squad's visibility and membership. If you have a Public Squad and aim to expand its reach, the directory is the perfect place to grow.
The [Squads Directory](https://app.daily.dev/squads) on daily.dev is a curated space where community members can discover new and engaging Public Squads. Being featured in the directory significantly boosts your Squad's visibility and membership. If you have a Public Squad and aim to expand its reach, the directory is the perfect place to grow.

## Eligibility Criteria for Directory Feature
## How to Get Featured in the Directory

To be featured in the daily.dev Public Squads Directory, your Squad must meet the following criteria:
Public Squads are automatically added to the Squads Directory once they are created and as long as they are well-maintained, but being featured in the directory is reserved for top-performing, high-quality Squads that meet specific criteria.

1. **Public Status**: Only Public Squads are eligible. Private Squads and non-public sources are not included in the directory.
2. **Editorial Selection**: Featured Squads are handpicked by our editorial team, ensuring that they represent quality, engagement, and compliance. (See our tips below for enhancing your chances of being selected.)
### Tips for Increasing Your Chances of Being Featured

This focus on editorially curated content ensures that Squads featured in the directory represent the best of daily.dev’s community, offering users a diverse and enriching experience.
1. **Choose the Right Category**: Make sure your Squad is placed in the most relevant category during setup (e.g., Languages, Web, AI). Choosing the right category helps your Squad reach the right audience.

## Tips to Increase Your Chances of Being Featured
2. **Optimize Your Metadata**:
- **Squad Image**: Use an eye-catching and relevant image for your Squad.
- **Description**: Write a clear and compelling description that highlights your Squad’s value and purpose.
- **Engaging Title**: Use a concise and descriptive title that attracts interest.

The decision to feature a Public Squad in the directory is editorial. However, you can increase your chances by following these best practices:
3. **Post High-Quality Content**:
- Share meaningful and engaging posts consistently.
- Curate tutorials, articles, and videos relevant to your community’s interests.
- Use Markdown to format content professionally.

1. **Post High-Quality Content Regularly**: Consistently sharing valuable content is the primary factor for being featured.
2. **Foster Active Engagement**: A thriving community with active discussions and interactions boosts the appeal of your Squad.
3. **Create Meaningful Interactions**: Regular posts and engaging discussions that resonate with your audience can elevate your Squad's appeal.
4. **Foster Active Engagement**:
- Encourage members to participate in discussions and post content.
- Engage with members by responding to comments and sharing feedback.

For any questions regarding Public Squads, feel free to contact us at [[email protected]](mailto:[email protected]).
5. **Grow Your Membership**:
- Actively invite developers who would benefit from your Squad.
- Promote your Squad through external channels like social media or your Slack workspace.

6. **Maintain Compliance**:
- Follow daily.dev’s content guidelines.
- Approve only high-quality, non-spammy posts.
- Monitor and report inappropriate content or behavior to keep your community safe.

## Benefits of Being Featured

Featured Squads gain several advantages that help them grow faster:

- **Increased Visibility**: Featured Squads are prominently displayed in the directory, making them more discoverable.
- **Credibility Boost**: The "Featured" badge signals quality and authority, encouraging more developers to join.
- **Engagement Opportunities**: Featured Squads often attract more active members, driving richer discussions and interactions.

## Directory Categories

The directory organizes Squads into categories to help developers find communities aligned with their interests. Categories include:

| **Category** | **Examples** |
|-----------------------|-----------------------------------------------|
| **Featured** | Editor’s choice for top Squads. |
| **Languages** | JavaScript, Python, Rust. |
| **Web** | React, Tailwind, Node.js. |
| **Mobile** | Flutter, Swift, Kotlin. |
| **DevOps & Cloud** | Kubernetes, AWS, Terraform. |
| **AI** | OpenAI, TensorFlow, GPT Models. |
| **Games** | Unity, Unreal Engine, Indie Game Design. |
| **DevTools** | GitHub Actions, Postman, Sentry. |
| **Career** | Leadership tips, job search, mentorship. |
| **Open Source** | OSS maintainers, Git practices, contributions.|
| **DevRel** | Community management, developer advocacy. |
| **Fun** | Memes, programming jokes, off-topic topics. |

## Reporting Inappropriate Squads

To maintain a high-quality directory, we encourage users to report any inappropriate or non-compliant Squads. Reports are reviewed by the daily.dev moderation team, ensuring that only safe, high-value communities remain listed.

For any questions about the Squads Directory or how to improve your chances of being featured, feel free to contact us at [[email protected]](mailto:[email protected]).

By focusing on high-quality content and meaningful engagement, your Squad could become one of the standouts in the Squads Directory. 🚀
28 changes: 22 additions & 6 deletions docs/squads/growing-your-squad.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,29 @@ Building your Squad starts with inviting other developers to join:
Encourage members to invite peers who may be interested in your Squad’s topics to grow your community.
:::

## Apply to Become a Public Squad
## The New Squads Directory

As your Squad grows and gains activity, you might consider transitioning it to Public status to increase visibility and engagement within the daily.dev community:
Public Squads are now automatically added to the [Squads Directory](https://app.daily.dev/squads), a curated space where developers can discover communities that align with their interests.

1. **Increased Exposure**: Public Squads are featured in the daily.dev feed, reaching a broader audience.
2. **Community Building**: Public status enables you to connect with more developers and expand your community.
### Categories in the Directory

For guidance on making your Squad public, including benefits, steps, and tips, refer to our [guide on becoming a Public Squad](/squads/public-squads.md). This guide will provide you with the information you need to successfully transition to Public status.
When creating a Public Squad, you must select a category that fits your Squad's theme. Categories include:
- **Featured**: Editor’s choice for top Squads on the platform.
- **Languages**: Programming language-specific communities.
- **Web, Mobile, DevOps & Cloud, AI, Games**: Development-focused categories.
- **DevTools**: Squads by or for developer tools companies.
- **Career**: Topics around career growth, leadership, and skills development.
- **Open Source, DevRel, Fun**: Specialized communities for unique developer interests.

In the following pages, you’ll learn about tools for moderating your Squad, managing member roles, and adjusting privacy settings.
### Tips for Gaining Visibility in the Directory

To improve your chances of being featured in the directory:
1. **Optimize Your Metadata**: Add an engaging image, clear description, and select the most relevant category.
2. **Grow Membership**: Invite members to join and participate actively.
3. **Post Consistently**: Regular high-quality posts boost engagement and visibility.

## Building an Engaged Community

An active Squad is key to growth. By regularly posting, approving member contributions, and sparking discussions, your Squad can become a vibrant hub for developers.

Good luck with growing your Squad! 🚀
71 changes: 59 additions & 12 deletions docs/squads/moderating-your-squad.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,81 @@ description: "Learn essential moderation tools and permissions management to eff

## Admin, Moderation, and Privacy Settings

As a Squad admin, you have various tools and settings to help manage your Squad effectively. Here’s how to make the most of them.
As a Squad admin, you have various tools and settings to help manage your Squad effectively. These tools enable you to foster a respectful and engaging environment for your members.

:::info
Note: The tools described here are foundational for Squad management. We’re actively developing advanced moderation options to support even more effective community management.
:::

## Deleting Posts, Comments, and Blocking Users
## Key Moderation Features

As an admin, maintaining a respectful community is your responsibility:
* **Deleting Posts or Comments**: To delete a post or comment that violates Squad guidelines, navigate to the post, click on the options menu, and select "Delete." Confirm in the pop-up window.
* **Blocking Users**: For repeated guideline violations, you can block a member. Blocking removes them from the Squad and prevents rejoining. To reverse this action, unblock them manually by locating the user in the member list, choosing "Block" from their options, and confirming.
**Post Approval**: Public Squads allow all members to post by default, but admins and moderators must approve posts before they go live. This ensures content aligns with your Squad’s code of conduct and quality expectations.

**Content Moderation**: Admins can delete posts and comments that violate guidelines to maintain a healthy discussion environment.

**User Management**: Block users who repeatedly violate guidelines, and reverse the action if necessary.

**Role Assignments**: Assign roles such as moderators or admins to trusted members to distribute management responsibilities.

**Reporting and Feedback**: Members can now report inappropriate Squads or posts. Reported content is reviewed by the daily.dev moderation team to maintain a safe and inclusive platform.

## Managing Posts

### Approving and Declining Posts

Public Squads have default settings where all members can post, but posts require admin or moderator approval.

1. **Approve or Decline Posts**: Review posts in the approval queue.
2. **Decline with Feedback**: Provide a reason for declining posts to help the author improve.
3. **Re-approval for Edits**: Posts must be re-approved after edits to prevent bypassing the moderation process.

### Deleting Posts and Comments

1. **Navigate to the Content**: Find the post or comment you need to delete.
2. **Select "Delete"**: Use the options menu to remove the content permanently. Confirm the action in the pop-up window.

### Blocking Users

If a member repeatedly violates guidelines:
1. **Find the User**: Locate the user in the member list.
2. **Select "Block"**: This removes them from the Squad and prevents rejoining.
3. **Unblock if Necessary**: You can reverse this action through the member list.

## Managing Permissions

* **Posting and Inviting**: Control who can post in the Squad and who can invite new members through the "Permissions" section in Squad settings.
* **Group Guidelines**: Create a pinned welcome post outlining the group’s rules and expectations for easy access.
Control member actions through the "Permissions" section in your Squad settings:
- **Posting Permissions**: Decide who can post and whether post approval is required (default for Public Squads).
- **Invitation Permissions**: By default, all members can invite others to join the Squad. Adjust this if needed.
- **Group Guidelines**: Create a pinned welcome post outlining the rules and expectations for members.

## Member Roles

Squad members can have different roles with distinct permissions:

* **Member**: Can read and write posts, and add comments, as allowed by the permissions set.
* **Moderator**: Has additional permissions to delete posts and comments and manage members following the rules set.
* **Admin**: The admin, typically the Squad creator, can manage all posts, comments, members, and modify Squad settings, including privacy and permissions.
- **Member**: Can read and write posts and comments, as allowed by permissions.
- **Moderator**: Can manage posts, comments, and members following the rules set.
- **Admin**: Full control over posts, comments, members, and Squad settings, including privacy and permissions.

### Managing Roles

![Promote to moderator cover image](https://daily-now-res.cloudinary.com/image/upload/v1690470250/docs/Update%20July%202023/promotomod.png)

* **Promoting to Moderator/Admin**: To promote a member, find them in the member list and select "Promote to Moderator" or "Make an Admin" from their options. They will then have access to moderation tools.
* **Demoting Moderators**: If a moderator is not meeting their responsibilities, you can demote them back to a member by selecting "Demote to Member" in their options menu.
1. **Promoting to Moderator or Admin**: Find a member in the list and select "Promote to Moderator" or "Make an Admin."
2. **Demoting Moderators**: Demote a moderator back to a member if they fail to meet responsibilities by selecting "Demote to Member."

## Privacy Settings

Decide whether your Squad is Public or Private:
- **Public Squads**: Open and discoverable in the Squads Directory.
- **Private Squads**: Invite-only, with content visible only to members.

Public Squads must comply with daily.dev’s content guidelines to maintain their visibility.

## Tips for Effective Moderation

- Set clear rules and expectations in a pinned post.
- Actively review and approve posts to maintain quality.
- Assign trusted members as moderators to share the workload.
- Regularly engage with members to foster a sense of community.

Effective moderation is key to growing a vibrant, respectful, and valuable Squad. 🚀
Loading

0 comments on commit d49d0ef

Please sign in to comment.