Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional guidance on self-promotional materials, with examples #1926

Merged
merged 1 commit into from
Jul 29, 2023

Conversation

ravindk89
Copy link
Collaborator

@ravindk89 ravindk89 commented Mar 27, 2023

Summary

We get a lot of Slack users who want to promote their own writings.

We do want to encourage users to share, but also don't want channels like #general and #watercooler to become targets for link farming.

This PR adds some guidance to hopefully make it clearer to users for when it's reasonable to post your own content into a channel. Specifically, we want to ensure that there is context to the ongoing conversation for any given bit of self-promo.

With this, posting an article you wrote on the comfort of your new keyboard mount in response to people asking about keyboards is a 🟢 . Dropping that link blindly into #general and walking away is 🔴


📚 Documentation preview 📚: https://writethedocs-www--1926.org.readthedocs.build/

@ravindk89 ravindk89 self-assigned this Mar 27, 2023
Copy link
Member

@ddbeck ddbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The core thing—being explicit that clicks are a thing of value for the purposes of self-promotion—is good. Some ideas about examples and cautions, in line comments. Thank you!

docs/slack.rst Outdated
Comment on lines 278 to 309
For example, a link to your own Hashnode or Medium article without being related to an ongoing conversation is Self-Promotional.
Similarly, a post to a virtual meetup or "Office Hours" setting where the purpose is evangelizing your own product(s) is Self-Promotional (even if it's your companies work and not your own!).
But if there is an ongoing conversation on a topic you've written or created content for, you can offer to post that content and do so if the community expresses interest.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of thoughts here:

Do we think people are confused by what counts as self-promotion? That is, we do need to explicitly call out these things as self-promotion? (I haven't had push back from folks—i.e. disagreement that something is self-promotion—but that's just my experience.)

Also, I really like the idea of using examples to help people understand what to do. What do you think of building this out into a little playbook? Something along these lines?

Here are some examples of common self-promotion situations and how to self-promote responsibly:

  • You've written a blog post that you want to share with the community, but it's not closely related to an ongoing discussion: share it in #community-showcase and tell us why you think it would be interesting to documentarians.
  • Your employer is hosting an event to promote their product or service (even if it's not the primary purpose of the event): share it in #community-events and tell others your connection to the event.
  • Someone else has asked a question and you're the author of an article that answers the question: reply by briefly summarizing your article, noting your authorship, and linking to the article.

And maybe…

  • You're offering cash for gold, selling diet supplements, representing the estate of a recently deceased and heretofore unknown family member, or doing some other activity unrelated to documentation: do not post.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No pushback yet, but I generally think the examples as guidance is nice - it leaves things less nebulous as to why one thing might be OK and another gets :spam:

And i like all of your suggestions :) Will implement shortly.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love these suggestions! I've had one guy get mad at me and swear up and down that people would recognize who he was and know that he was a valued community member who would never advertise to them...and I'd never heard of him before 😂 Other than that, people tend to be pretty reasonable, and these guidelines spell it out really nicely!

docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
@ravindk89
Copy link
Collaborator Author

@ddbeck @janine-c more edits incoming and an attempt at formatting.

Copy link
Contributor

@plaindocs plaindocs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this.

docs/slack.rst Show resolved Hide resolved
@plaindocs
Copy link
Contributor

@ravindk89 shall we merge this? Or are we waiting for anything else?

Copy link
Member

@ddbeck ddbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is too late for me to review this version? I realize I let this sit way too long, so consider this all completely optional.

(I can do my own follow up PR, if you prefer.)

docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated
@@ -259,22 +259,48 @@ In addition to the guidance that applies to all participants, we expect self-pro
Clearly explain what you are promoting, why it matters to documentarians, and your involvement.
Be up front about paywalls, registration requirements, referral benefits, or commissions.
If you're running a survey, say when and how the results will be published.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These spaces don't appear elsewhere. Do you want to add them to all the bulleted lists, or none of them? (My kingdom for a Prettier-like formatter for reStructuredText.)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets do none for consistency.

docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated
Here are some examples of common self-promotion situations, and some guidelines on how to self-promote responsibly:

You've written a blog post (Medium, Hashnode, etc.) that you want to share with the community, but it's not closely related to an ongoing discussion
**DO** share it in #community-showcase and tell us why you think it would be interesting or relevant to documentarians
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Channel names are **#channel-name** on the rest of the page, so I'd assume we should use the same convention here (this would need correcting throughout this section)

Suggested change
**DO** share it in #community-showcase and tell us why you think it would be interesting or relevant to documentarians
**DO** share it in **#community-showcase** and tell us why you think it would be interesting or relevant to documentarians

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done manually

docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
@ravindk89
Copy link
Collaborator Author

Is too late for me to review this version? I realize I let this sit way too long, so consider this all completely optional.

(I can do my own follow up PR, if you prefer.)

These are good suggestions. I'll implement them today/tomorrow, I have the cycles for it

Copy link
Collaborator Author

@ravindk89 ravindk89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ddbeck I have integrated your feedback.

docs/slack.rst Outdated
@@ -259,22 +259,48 @@ In addition to the guidance that applies to all participants, we expect self-pro
Clearly explain what you are promoting, why it matters to documentarians, and your involvement.
Be up front about paywalls, registration requirements, referral benefits, or commissions.
If you're running a survey, say when and how the results will be published.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets do none for consistency.

docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated
Here are some examples of common self-promotion situations, and some guidelines on how to self-promote responsibly:

You've written a blog post (Medium, Hashnode, etc.) that you want to share with the community, but it's not closely related to an ongoing discussion
**DO** share it in #community-showcase and tell us why you think it would be interesting or relevant to documentarians
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done manually

docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
Copy link
Member

@ddbeck ddbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm down to just little style and consistency nitpicking. Thank you!

docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
docs/slack.rst Outdated Show resolved Hide resolved
@ravindk89
Copy link
Collaborator Author

All picks have been neatly placed @ddbeck

docs/slack.rst Outdated Show resolved Hide resolved
@plaindocs
Copy link
Contributor

Heroic effort from all concerned here. :shipit: !

@ravindk89
Copy link
Collaborator Author

@plaindocs I can rebase and squash so we don't have the merge commit in there if you'd like

ddbeck suggestion

Co-authored-by: Daniel D. Beck <daniel@ddbeck.com>

janine-c edits

Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>

Apply suggestions from code review

Co-authored-by: Daniel D. Beck <daniel@ddbeck.com>

ddbeck with the layup

Co-authored-by: Daniel D. Beck <daniel@ddbeck.com>
@plaindocs
Copy link
Contributor

Up to you @ravindk89 , we're not super picky about those things in this repo. But no reason not to.

@ravindk89
Copy link
Collaborator Author

ravindk89 commented Jul 28, 2023 via email

@ravindk89
Copy link
Collaborator Author

@plaindocs I do love a clean commit tree.

@plaindocs
Copy link
Contributor

@ravindk89 please merge at will!

@ravindk89 ravindk89 merged commit 00a5854 into main Jul 29, 2023
6 checks passed
@ravindk89 ravindk89 deleted the slack-self-posting branch July 29, 2023 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants