Agora Community - Content Contributors Guides

This repository will contain all documents related to the process for publishing content for as part of the Agora Content Contributors (ACC) initiative. Please read the sections below and follow the instructions before submitting content for review/publication.

Agora Content Contributors are developers who create content for the Agora community. The work of community contributors expands and strengthens Agora’s Real-Time Engagement Platform tutorials.

For more information please reach out to community@agora.io.

Writing Process

After you’ve submitted your application, a member of the Agora Dev Evangelist team will work with you to refine your outline and the feature set of your tutorial.

When writing ACC content, tutorials must follow the writing template structure (Google Doc version) and writing style guidelines.

Once the tutorial is written, authors must include a headline and the meta data tags (author, description, and keywords) for their submissions.

  <meta name="description" content="Agora Web tutorial ...">
  <meta name="keywords" content="HTML, CSS, JavaScrip, Live Broadcasting, Video">
  <meta name="author" content="Jane Doe">

For more information on meta tags see W3School's Meta Tag

Authors must also include an "About the author" description, giving some background and highlights about the author. Authors are requested to include a photo of themselves and their social media handles.

Once the tutorial is complete and ready for review, the Agora team will work with you to submit your first draft for review.

Review Submissions

When submitting content for review it must be submitted as BOTH a draft link on Medium and Google Doc. The Medium draft will represent the tutorial with its final formatting, while the Google Doc will be used to add suggestions, comments, and any other feedback during the review process.

For more details see the Medium Help Center guide "Share a draft"

Along with the two draft links, inlcude the GitHub repo link for the completed code from your tutorial.

After you’ve submitted your first draft, an Agora Evangelist team member will pair you with an editor to help you revise and polish your work.

Once the comments and suggestions are all resolved on the Google Doc, the author will make the corresponding updates to the Medium draft. After all updates are made and the article is ready for publication, the Agora team will work with you to submit your project for publication.

Publishing Process

Once the editting process is complete, the tutorial will first be published on the Agora Blog. Upon publication of the tutorial on the Agora Blog, the author will be provided with a URL to the tutorial that will be used as the canonical link within the Advanced settings of the Medium post.

For more details see the Medium Help Center guide "Set a canonical link"

Once the canonical link is set, the author may publish their tutorial to Medium.

Social Promotion

Once the article is posted live, authors are encouraged to share the link to their various social media channels. When sharing on social media, authors are encouraged to tag Agora's social accounts.