nhcarrigan/docs
2
0
Fork 0
generated from nhcarrigan/template
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: various docs updates

Browse Source
This commit is contained in:
Naomi Carrigan
2025-01-22 20:54:06 -08:00
parent b8650dfa73
commit 40808b6dfe
10 changed files with 177 additions and 1473 deletions
Download Patch File Download Diff File Expand all files Collapse all files

279
src/content/docs/about/contact.md
View File

@ -6,17 +6,12 @@ title: Contact Policy
### 1.1 Public Support Channels
:::tip
We have a ticket system within our Discord server which allows for private communication with the staff team.
This is considered a public support platform and is not billed!
:::
We offer FREE support through several PUBLIC channels, including:
- Community Forums
- Public GitHub Issues
- Open Discord Servers
- Social Media Platforms
- Public Repository Issues
- Open IRC Channels
- Custom Fediverse Instance
These channels are ideal for:
@ -49,117 +44,77 @@ Our platforms offer various ways to engage with our projects and community:
Below, you'll find a comprehensive list of our official communication platforms. Each platform serves specific purposes and caters to different types of interactions. Please choose the most appropriate channel for your needs to ensure the fastest and most effective response.
## 2. Account Verification
### 1.5 Contact Form
### 2.1 List of Verified Accounts
We offer a [contact form](https://forms.nhcarrigan.com/contact) for direct, low-prioirity communication requests.
We maintain a comprehensive list of all our verified accounts across different platforms. This list is regularly updated to reflect any changes or additions to our official online presence.
It is often faster to reach out through one of the above platforms, and best to consider this contact form as a backup in the event of a severe outage.
- View our verified accounts: https://cdn.nhcarrigan.com/socials.txt
## 2. Communication Platforms
### 2.2 GPG Key for Verification
### 2.1 IRC
To ensure the integrity of our verified accounts list, we use GPG (GNU Privacy Guard) encryption. You can download our public GPG key to verify the authenticity of the list.
Our custom IRC network allows for real-time communication with your fellow community members.
- Download our GPG key: https://cdn.nhcarrigan.com/key.pgp
:::note
We do not have an IRC bouncer. The only people who will see your messages are the ones who are online when it is sent.
:::
### 2.3 Verification Process
Follow these steps to verify the integrity of our verified accounts list:
- Download both the verified accounts list and our GPG key from the links provided above.
- Open a terminal or command prompt on your system.
- Navigate to the directory where you saved the files.
- Run the following command:
```
gpg -f /path/to/key --verify /path/to/socials
```
Replace `/path/to/key` with the path to the downloaded GPG key file, and `/path/to/socials` with the path to the downloaded verified accounts list.
If the verification is successful, you'll see a message confirming the signature is valid.
### 2.4 Importance of Verification
Verifying our accounts helps you:
- Avoid impersonation attempts
- Ensure you're interacting with official channels
- Protect yourself from potential scams or misinformation
### 2.5 Reporting Suspicious Accounts
If you encounter an account claiming to represent us but not listed in our verified accounts:
- Do not engage with or share sensitive information with the account
- Report the suspicious account to us immediately through one of our verified channels
- If possible, report the account to the platform it's on for impersonation
### 2.6 Staying Updated
We recommend checking our verified accounts list periodically, as we may add new official accounts or remove outdated ones. Always use the verification process to ensure you have the most current and authentic list.
## 3. Real-Time Communication Platforms
### 3.1 Discord Server
Our Discord server is the primary and most active platform for real-time communication.
- Join Link: https://chat.naomi.lgbt
- Join Link: https://irc.nhcarrigan.com
- Features:
- Fastest response times
- Multiple topic-specific channels
- Voice chat capabilities
- Integration with our projects and bots
- Best for: Quick support, community discussions, and live collaboration
### 3.2 Matrix Space
### 2.2. Forum
For those who prefer an open-source alternative to Discord, we maintain a Matrix space.
Our self-hosted forum allows for more long-form communication, which is ideal for support queries and in-depth conversations.
- Join Link: https://matrix.to/#/#naomis:matrix.org
- Join Link: https://forum.nhcarrigan.com
- Features:
- Decentralized and open-source
- End-to-end encryption for private messages
- Cross-platform compatibility
- Best for: Privacy-conscious users and those who prefer open protocols
- Quick response times
- Threaded conversations
- Persistent and indexed posts
- Best for: Support queries
### 3.3 IRC Channels
### 2.3. Fediverse
For users who prefer traditional IRC, we maintain channels on LiberaChat.
We self-host a fediverse instance for our random thoughts.
- Network: LiberaChat
- Channels:
- #nhcarrigan - Main support and discussion channel
- #nhcarrigan-chat - Casual conversation and community chat
- Connection Guide: LiberaChat Connection Guide
:::caution
The instance is invite-only and invites are reserved for our core team and polycule. But you can follow and engage with any Mastodon-compliant instance!
:::
- Link: https://fedi.nhcarrigan.com
- Features:
- Lightweight and accessible from various clients
- Suitable for users with limited bandwidth
- Familiar interface for long-time internet users
- Best for: Users comfortable with traditional IRC interfaces and those seeking a minimal, text-based chat experience
- Microblogging platform
- Likes + reposts
- Best for: General chatter
### 3.4 Platform Choice Guidelines
### 2.4. Code Repositories
- Discord: Recommended for most users, especially those seeking quick responses or community interaction.
- Matrix: Ideal for users prioritizing privacy and open-source solutions.
- IRC: Best for those who prefer a classic, lightweight chat experience or are using older hardware.
Our code repositories are all self-hosted. Sign-ups are open for anyone who wants to file an issue or comment on a discussion, but making code contributions is restricted to our core team.
### 3.5 Etiquette and Best Practices
- Link: https://git.nhcarrigan.com
- Features:
- Issue tracking
- Source code for all of our products
- Best for: Filing tickets on our software.
### 2.5 Etiquette and Best Practices
- Please be respectful and follow the community guidelines on all platforms.
- Use appropriate channels or rooms for your queries to ensure the fastest response.
- Before asking a question, check if it has been answered in pinned messages or FAQs.
- When seeking help, provide as much relevant information as possible.
## 4. Announcements and Updates
## 3. Announcements and Updates
### 4.1 Reddit Board
### 3.1 Announcements Page
Our Reddit board serves as the primary hub for official announcements and updates.
We have a dedicated page where we post all of our organisational updates.
- URL: https://www.reddit.com/r/nhcarrigan/
- URL: https://announcements.nhcarrigan.com
- Nature: This board is read-only.
- Content:
- Project updates and new releases
@ -168,53 +123,29 @@ Our Reddit board serves as the primary hub for official announcements and update
- Major policy changes
- Best for: Comprehensive, detailed announcements and long-form updates
### 4.2 Social Media Platforms
### 3.2 Blog
For more frequent and concise updates, we cross-post select announcements to our social media accounts.
Our blog contains more personal posts and updates.
#### 4.2.1 Twitter
- Account: @naomi_lgbt
- URL: https://blog.nhcarrigan.com
- Nature: This board is read-only.
- Content:
- Brief announcements and updates
- Quick tips and insights
- Community engagement
- Personal life updates
- Random musings
- Cool insights into our decision making processes
- Best for: People who want more insight into the team behind NHCarrigan.
#### 4.2.2 Mastodon
### 3.3 Interacting with Announcements
- Account: @naomi_lgbt@mastodon.social
- Content:
- Similar to Twitter
- Greater focus on personal activities
All of our announcements are read-only, but you can discuss them in any of our platforms mentioned in Section 1!
### 4.3 Interacting with Announcements
### 3.6 Historical Announcements
- Reddit: The board is read-only. For questions or discussions about announcements, please use our Discord server or other interactive platforms.
- Twitter and Mastodon: You can reply to posts or @mention us with questions or comments. We encourage community engagement on these platforms.
All announcements on our board are archived and remain accessible for future reference.
### 4.4 Best Practices for Staying Informed
## 4. Professional Engagement and Portfolio
- Subscribe to Multiple Channels: Each platform may have slightly different content. Following multiple channels ensures you don't miss any important updates.
- Enable Notifications: Consider enabling notifications for critical updates on your preferred platform.
- Regular Check-ins: If you prefer not to use notifications, we recommend checking these channels regularly, especially before starting work on or with our projects.
- Cross-Reference: Major announcements will typically be posted across all platforms. If you see something important on one channel, you can cross-reference it on others for any additional details.
### 4.5 Emergency or Critical Updates
For time-sensitive or critical announcements:
- We will use all available channels to ensure maximum reach.
- Such announcements will be clearly marked as urgent or critical.
- We may use additional notification methods (e.g., email for registered users) for extremely critical updates.
### 4.6 Historical Announcements
- All announcements on our Reddit board are archived and remain accessible for future reference.
- While social media posts may have limited visibility over time, all major announcements will be permanently available on Reddit.
## 5. Professional Engagement and Portfolio
### 5.1 LinkedIn Profile
### 4.1 LinkedIn Profile
LinkedIn serves as our primary professional networking platform.
@ -228,11 +159,11 @@ LinkedIn serves as our primary professional networking platform.
- Professional collaborators
- Industry peers
#### 5.1.1 Connecting on LinkedIn
#### 4.1.1 Connecting on LinkedIn
When sending a connection request, please include a brief message explaining your interest. We typically respond to LinkedIn messages within 2-3 business days.
### 5.2 Peerlist Profile
### 4.2 Peerlist Profile
As an alternative to LinkedIn, we maintain a presence on Peerlist, a platform focused on tech professionals.
@ -246,11 +177,11 @@ As an alternative to LinkedIn, we maintain a presence on Peerlist, a platform fo
- Fellow developers and engineers
- Open-source collaborators
#### 5.2.1 Engaging on Peerlist
#### 4.2.1 Engaging on Peerlist
Feel free to explore our projects and contributions on Peerlist. You can leave comments or questions on specific items in our portfolio.
### 5.3 Professional Inquiries
### 4.3 Professional Inquiries
When reaching out for professional reasons, please consider the following:
@ -258,27 +189,23 @@ When reaching out for professional reasons, please consider the following:
- Relevant Background: Provide brief context about yourself or your company.
- Specific Questions: If you have particular queries, include them in your initial message.
### 5.4 Services
### 4.4 Services
For details about our services and past work, visit our portfolio: https://nhcarrigan.com
If you're interested in hiring us to perform some work for you, fill out the form at https://forms.nhcarrigan.com/commission.
### 5.5 Speaking Engagements and Events
### 4.5 Speaking Engagements and Events
If you're interested in having us speak at your event or contribute to your publication:
If you're interested in having us speak at your event or contribute to your publication, fill out the form at https://forms.nhcarrigan.com/events.
- Check our LinkedIn or Peerlist profiles for recent talks or articles.
- Reach out with specific details about your event or publication.
- Provide information about the audience, topic, and any other relevant details.
### 5.6 Keeping Professional Connections Updated
### 4.6 Keeping Professional Connections Updated
We regularly update our professional profiles with new projects, skills, and achievements. Follow us on these platforms to stay informed about our professional journey and potential opportunities for collaboration.
## 6. One-on-One Sessions
## 5. One-on-One Sessions
We offer personalized, one-on-one sessions to cater to various needs, from casual conversations to in-depth consultations. Book your session through our Topmate profile.
### 6.1 Coffee Chat
### 5.1 Coffee Chat - $50
A casual, informal conversation to connect and share ideas.
@ -292,7 +219,7 @@ A casual, informal conversation to connect and share ideas.
- Professionals seeking to expand their network
- Anyone interested in a friendly chat about tech and open source
### 6.2 Consulting Session
### 5.2 Consulting Session - $100
A focused, one-on-one session to discuss potential new projects and align our services with your needs.
@ -306,7 +233,7 @@ A focused, one-on-one session to discuss potential new projects and align our se
- Project managers seeking technical guidance
- Startups needing expert input on their tech stack
### 6.3 Mentorship Session
### 5.3 Mentorship Session - $200
An in-depth, personalized session focused on long-term professional growth and skill development.
@ -320,30 +247,28 @@ An in-depth, personalized session focused on long-term professional growth and s
- Professionals looking to transition into tech
- Anyone seeking structured, long-term professional development
### 6.4 How to Book a Session:
### 5.4 How to Book a Session:
- Visit one of:
- Our Topmate profile: https://topmate.io/nhcarrigan
- Our Fiverr profile: https://www.fiverr.com/nhcarrigan
- Select the type of session you need (Coffee Chat, Consulting, or Mentorship)
- Select an available time slot
- Complete the booking process and payment
- Complete the [meeting request form](https://forms.nhcarrigan.com/session)
- Wait for an email to schedule a time
- Once a time is agreed upon, you will receive an invoice via email.
- The invoice MUST be paid at least 24 hours prior to your session.
### 6.5 Preparing for Your Session:
### 5.5 Preparing for Your Session:
- Coffee Chat: Come with topics you'd like to discuss or questions about the industry
- Consulting: Prepare a clear description of your problem or project, and any relevant code or documentation
- Mentorship: Outline your career goals and areas where you'd like to improve
### 6.6 Additional Information:
### 5.6 Additional Information:
- All sessions are conducted virtually via a video call in our Discord server.
- All sessions are conducted virtually via a video call over Zoom or Google Meet.
- Payment is required at the time of booking
- Rescheduling is possible with at least 24 hours notice
For any questions about these sessions or to discuss a different type of engagement, please reach out through our preferred contact methods listed in previous sections.
## 7. Email Communication
## 6. Email Communication
:::caution
Email communication is considered a paid service and will be invoiced at $25 per email we receive.
@ -351,7 +276,7 @@ Email communication is considered a paid service and will be invoiced at $25 per
We offer several email addresses for specific types of inquiries. Please use the appropriate email address to ensure your message reaches the right team and receives the most efficient response.
### 7.1 General Inquiries
### 6.1 General Inquiries
- Email: contact@nhcarrigan.com
- Use for:
@ -360,7 +285,7 @@ We offer several email addresses for specific types of inquiries. Please use the
- Media or press inquiries
- Any queries that don't fit other categories
### 7.2 Billing and Financial Matters
### 6.2 Billing and Financial Matters
- Email: billing@nhcarrigan.com
- Use for:
@ -369,7 +294,7 @@ We offer several email addresses for specific types of inquiries. Please use the
- Refund requests
- Updating billing information
### 7.3 Technical Support
### 6.3 Technical Support
- Email: support@nhcarrigan.com
- Use for:
@ -377,7 +302,7 @@ We offer several email addresses for specific types of inquiries. Please use the
- Reporting bugs or technical issues
- Documentation clarifications
### 7.4 Privacy Concerns
### 6.4 Privacy Concerns
- Email: privacy@nhcarrigan.com
- Use for:
@ -386,7 +311,7 @@ We offer several email addresses for specific types of inquiries. Please use the
- Reporting potential privacy breaches
- Opting out of data collection (where applicable)
### 7.5 Security Matters
### 6.5 Security Matters
- Email: security@nhcarrigan.com
- Use for:
@ -394,7 +319,7 @@ We offer several email addresses for specific types of inquiries. Please use the
- Questions about our security practices
- Concerns about potential security breaches
### 7.6 Legal Inquiries
### 6.6 Legal Inquiries
- Email: legal@nhcarrigan.com
- Use for:
@ -403,7 +328,7 @@ We offer several email addresses for specific types of inquiries. Please use the
- Requests for legal documentation
- Formal notices or communications
### 7.7 Feedback and Suggestions
### 6.7 Feedback and Suggestions
- Email: feedback@nhcarrigan.com
- Use for:
@ -412,7 +337,7 @@ We offer several email addresses for specific types of inquiries. Please use the
- Sharing your experience with our services
- Offering ideas for future developments
### 7.8 Email Communication Guidelines
### 6.8 Email Communication Guidelines
- Subject Line: Please use a clear, concise subject line that summarizes your inquiry.
- Content: Provide all relevant details in your initial email to expedite the response process.
@ -420,7 +345,7 @@ We offer several email addresses for specific types of inquiries. Please use the
- Response Time: We aim to respond to all emails within 2 business days. Complex inquiries may require additional time.
- Follow-ups: If you haven't received a response after 3 business days, feel free to send a polite follow-up.
### 7.9 Email Privacy and Security
### 6.9 Email Privacy and Security
All email communications are treated as confidential.
@ -428,13 +353,13 @@ We do not share your email address or the content of your messages with third pa
- Required by law; OR
- As part of a public warning related to a violation of our Code of Conduct
### 7.10 Spam and Unsolicited Emails
### 6.10 Spam and Unsolicited Emails
We have a strict no-spam policy. If you receive any unsolicited emails claiming to be from us, please report them to security@nhcarrigan.com.
By using the appropriate email address for your inquiry, you help us provide you with the most efficient and accurate response possible. If you're unsure which email to use, feel free to send your inquiry to contact@nhcarrigan.com, and we'll direct it to the appropriate team.
### 7.11 Acceptable Use and Consequences
### 6.11 Acceptable Use and Consequences
We are committed to maintaining a respectful and productive communication environment. To ensure this:
@ -453,59 +378,55 @@ We reserve the right to report serious abuses to relevant authorities if necessa
By communicating with us via email, you agree to adhere to these guidelines and understand the consequences of misuse.
## 8. Direct Messages
## 7. Direct Messages
:::caution
Direct messages (DMs) are considered a paid service and will be invoiced at $25 per message we receive.
:::
### 8.1 Direct Message Policy
### 7.1 Direct Message Policy
We offer direct messaging as a premium, personalized communication channel. However, to manage our time effectively and ensure the highest quality of service, we have implemented the following policy for direct messages:
- Each direct message received will be invoiced at $25.
- This applies to all platforms where direct messaging is available, including but not limited to:
- Discord
- Twitter
- LinkedIn
- Any other social media or communication platforms
- This applies to all platforms where direct messaging is available.
### 8.2 Purpose and Use
### 7.2 Purpose and Use
Direct messages should be used for:
- Urgent matters that cannot be addressed through public channels
- Sensitive information that shouldn't be shared publicly
- Personalized support or consultation requests
### 8.3 Invoicing and Payment
### 7.3 Invoicing and Payment
- An invoice will be generated for each direct message received.
- Payment is required before a response will be provided.
- Invoices will be sent to you via the direct message channel on the platform where the direct message was received.
### 8.4 Response Time
### 7.4 Response Time
- Once payment is received, we aim to respond to direct messages within 1-2 business days.
- Complex inquiries may require additional time, which will be communicated to you.
### 8.5 Refund Policy
### 7.5 Refund Policy
- Due to the immediate nature of the service, refunds for direct messages are not typically offered.
- In exceptional circumstances, refund requests will be considered on a case-by-case basis.
### 8.6 Appropriate Use
### 7.6 Appropriate Use
- Direct messages should be used responsibly and for legitimate purposes only.
- Abusive, harassing, or spam messages will not be tolerated and may result in blocking or reporting to the platform.
### 8.7 Alternatives
### 7.7 Alternatives
We encourage users to consider the following alternatives before sending a direct message:
- Use our public support channels for general inquiries (see Section 1.1)
- Check our FAQ or documentation for commonly asked questions
- Post in our community forums for non-urgent matters
### 8.8 Consent and Acknowledgment
### 7.8 Consent and Acknowledgment
By sending a direct message, you acknowledge that you have read and agreed to this policy, including the fee structure and invoicing process.