From 392872d67c1e34e1e7358abbd9712b30beacd77d Mon Sep 17 00:00:00 2001 From: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com> Date: Thu, 4 Aug 2022 08:32:24 +0900 Subject: [PATCH] Handbook - add article submission process (#6936) * add article submission process - added process-for-submitting-and-publishing-articles.md - renamed article-formatting-guide.md - updated links on README.md * add anchor links - add anchor links * formatting changes and link fixes - Changed up some formatting and fixed a couple of broken anchor links. * Update handbook/digital-experience/process-for-submitting-and-publishing-articles.md Co-authored-by: Chris McGillicuddy <108031970+chris-mcgillicuddy@users.noreply.github.com> * Update handbook/digital-experience/process-for-submitting-and-publishing-articles.md Co-authored-by: Chris McGillicuddy <108031970+chris-mcgillicuddy@users.noreply.github.com> * Update handbook/digital-experience/process-for-submitting-and-publishing-articles.md Co-authored-by: Chris McGillicuddy <108031970+chris-mcgillicuddy@users.noreply.github.com> * Update handbook/digital-experience/process-for-submitting-and-publishing-articles.md Co-authored-by: Chris McGillicuddy <108031970+chris-mcgillicuddy@users.noreply.github.com> * Update handbook/digital-experience/process-for-submitting-and-publishing-articles.md Co-authored-by: Chris McGillicuddy <108031970+chris-mcgillicuddy@users.noreply.github.com> * Update handbook/digital-experience/process-for-submitting-and-publishing-articles.md Co-authored-by: Chris McGillicuddy <108031970+chris-mcgillicuddy@users.noreply.github.com> * Update handbook/digital-experience/process-for-submitting-and-publishing-articles.md Co-authored-by: Chris McGillicuddy <108031970+chris-mcgillicuddy@users.noreply.github.com> * Update handbook/digital-experience/process-for-submitting-and-publishing-articles.md * Update process-for-submitting-and-publishing-articles.md - changed the title meta tag to lowercase. * title update - updated the page title in response to https://github.com/fleetdm/fleet/pull/7021 - fixed up some internal links to related pages Co-authored-by: Chris McGillicuddy <108031970+chris-mcgillicuddy@users.noreply.github.com> --- handbook/digital-experience/README.md | 2 +- ...delines.md => article-formatting-guide.md} | 10 +-- .../how-to-submit-and-publish-an-article.md | 82 +++++++++++++++++++ 3 files changed, 88 insertions(+), 6 deletions(-) rename handbook/digital-experience/{article-formatting-guidelines.md => article-formatting-guide.md} (94%) create mode 100644 handbook/digital-experience/how-to-submit-and-publish-an-article.md diff --git a/handbook/digital-experience/README.md b/handbook/digital-experience/README.md index 902316a87d..fd840c7f12 100644 --- a/handbook/digital-experience/README.md +++ b/handbook/digital-experience/README.md @@ -26,7 +26,7 @@ Detail the minimum time needed for new or updated content to be live (published) | Content | To publish | To revise (for editors) | Timeframe | |:------ |:-----------------|:-------------------------------|-----------| -| Articles | **Queued** – see _(TODO: Publishing articles on fleetdm.com)_. | **Absorb** (pair or feedback as needed) – see [How to edit articles, release posts, and press releases](#how-to-edit-articles-release-posts-and-press-releases). | three business days | +| Articles | **Queued** – see [Process for submitting and publishing articles](./process-for-submitting-and-publishing-articles). | **Absorb** (pair or feedback as needed) – see [How to edit articles, release posts, and press releases](#how-to-edit-articles-release-posts-and-press-releases). | three business days | | Ads | **Gated**. Request review from Digital Experience – see _(TODO: Creating an ad campaign)_. | **Feedback** or **pair** | five business days | | Docs | **Gated**. Request review from Desmi Dizney – see _(TODO: Adding to the docs)_. | **Absorb** – see [How to edit Markdown pull requests for the docs](#how-to-edit-markdown-pull-requests-for-the-docs). For non-grammar-related revisions: **Feedback** or **pair** with contributor, and request review from the [on-call engineer](https://fleetdm.com/handbook/engineering#oncall-rotation). | two business days | | Docs (REST API) | **Gated**. Request review from Luke Heath – see _(TODO: Adding to the docs (REST API))_. | **Absorb** – see [How to edit recently merged Pull Requests for the handbook and docs](#how-to-edit-recently-merged-pull-requests-for-the-handbook). For non-grammar-related revisions: **Feedback** or **pair** with contributor, and request review from Luke Heath. | two business days | diff --git a/handbook/digital-experience/article-formatting-guidelines.md b/handbook/digital-experience/article-formatting-guide.md similarity index 94% rename from handbook/digital-experience/article-formatting-guidelines.md rename to handbook/digital-experience/article-formatting-guide.md index eb1bf6ce7d..2f16ef13c9 100644 --- a/handbook/digital-experience/article-formatting-guidelines.md +++ b/handbook/digital-experience/article-formatting-guide.md @@ -1,4 +1,4 @@ -# Article formatting guidelines +# Article formatting guide To publish an article, you will need to create a Pull Request for a new file, formatted in Markdown (todo), in [https://github.com/fleetdm/fleet/tree/main/articles](https://github.com/fleetdm/fleet/tree/main/articles). @@ -7,7 +7,7 @@ To publish an article, you will need to create a Pull Request for a new file, fo - [Images and screenshots](#images-and-screenshots) - [Meta tags](#meta-tags) - [Customizable CTA](#customizable-cta) -- [Other pages of interest](#other-pages-of-interest) +- [Related pages](#related-pages) ## Layout The following layout guide aims to help you create consistently formatted articles. For an existing article example, check out the [Markdown](https://raw.githubusercontent.com/fleetdm/fleet/main/articles/tales-from-fleet-security-speeding-up-macos-updates-with-nudge.md) and the [finished result](https://fleetdm.com/securing/tales-from-fleet-security-speeding-up-macos-updates-with-nudge). @@ -129,10 +129,10 @@ In the following example we will modify `title`, `text`, `primary-button-text`, ![Customizable CTA example](../../images/cta-example-2-900x280@2x.jpg) -## Other pages of interest -- [Process for submitting and publishing articles](https://docs.google.com/document/d/1owejJ7PjCVm0e21QNXjzw7SRMa3FdkRxb8WoHkKxWRE/edit?usp=sharing) +## Related pages +- [How to submit and publish an article](./how-to-submit-and-publish-an-article.md) - Markdown guide (todo) - Writing style guide (todo) - \ No newline at end of file + \ No newline at end of file diff --git a/handbook/digital-experience/how-to-submit-and-publish-an-article.md b/handbook/digital-experience/how-to-submit-and-publish-an-article.md new file mode 100644 index 0000000000..705cc0b8b2 --- /dev/null +++ b/handbook/digital-experience/how-to-submit-and-publish-an-article.md @@ -0,0 +1,82 @@ +# How to submit and publish an article + +This guide includes everything you need to know about Fleet’s editorial process between submission and publication. + +> For help with formatting your article, check out our [article formatting guide](./article-formatting-guide). + +### On this page + +- [Article DRIs](#article-dris) +- [Who can publish articles?](#who-can-publish-articles) +- [Communication](#communication) +- [Schedule](#schedule) +- [How to submit an article](#how-to-submit-an-article) +- [Review process](#review-process) +- [Pre-publication checklist](#pre-publication-checklist) +- [After publication](#after-publication) + +## Article DRIs + +| Activity | DRI | +|:---------|:----| +| Assign & schedule | Tim Kern | +| Review | Chris McGillicuddy | +| Artwork | Mike Thomas | +| Publication | Tim Kern | + +## Who can publish articles? + +Everyone is welcome to suggest article ideas or submit drafts. To suggest an article, open an issue in the Fleet repo using the article suggestion template (TODO), include a summary, and tag Tim Kern. + +## Communication + +Use [#help-content-calendar](https://fleetdm.slack.com/archives/C03PH3BBVSM) on Slack for questions and updates related to articles. + +## Schedule + +Publishing occurs according to our [content calendar](https://docs.google.com/spreadsheets/d/1IzpoIfTc7cqc9g8w20fQfap3GFcrqgOaiPrpCkowcvA/edit?usp=sharing). However, publication dates are subject to change based on the news or information that needs to be posted. For time-sensitive articles, consult with Tim Kern in [#help-content-calendar](https://fleetdm.slack.com/archives/C03PH3BBVSM) on Slack. + +## How to submit an article + +1. Familiarize yourself with our [article formatting guide](./article-formatting-guide) and writing style guide (todo). +2. Create a pull request for fleetdm.com with a file of your article, formatted in Markdown (todo). +3. Include any relevant images, image suggestions, or other design requests you may have. + +> **IMPORTANT**: Your PR is not confidential. If the information in your article is confidential, please prepare your article in a Google Doc, or create a draft PR ~1 hour before publication time to keep your article private. + +## Review process + +Articles are official Fleet communication. We carefully review published content to make sure Fleet, the company and the product, are accurately represented. + +- Digital Experience will review your article for spelling, punctuation, and grammar, as well as for tone and brand consistency. +- In some cases, a technical review by a member of Engineering or Security may be necessary. +- After review, you may be asked to make revisions to your draft. + +### Typical editing timelines are as follows: + +| Type | Review time | +|:-----|:------------| +| Urgent posts |One business day | +| Non-urgent posts | Three business days | +| Posts requiring a technical review | Three business days | + +> Review times for posts requiring a technical review may vary depending on the Engineering and Security teams' schedules. E.g., if a review coincides with a product release. + +## Pre-publication checklist + +- Does the article meet the original brief and keyword goals? +- Has the article been reviewed by Digital Experience for grammar edits and brand consistency? +- Does the article require a technical review? +- Do all links work correctly and open in a new window? +- Does the article contain the correct [meta tags](./article-formatting-guide.md#meta-tags) +- Has artwork been created by Digital Experience? +- Does the article have a clear [call to action (CTA)](./article-formatting-guide.md#customizable-cta)? + +## After publication + +After your article is published, the Growth team will schedule your post to be promoted across our social media channels. + +> Consider promoting your article on your personal channels to help achieve a bigger impact. Depending on the article, the Growth team may make a request in [#help-promote](https://fleetdm.slack.com/archives/C026W5TC10V) on Slack. + + + \ No newline at end of file