Handbook - Digital Experience housekeeping (#7048)

README:
- fixed broken link for "how to submit and publish an article

How to submit and publish an article:
- added links to "Article formatting guide" and "Markdown guide"

Article formatting guide:
- added link to Markdown guide
This commit is contained in:
Mike Thomas 2022-08-04 15:37:29 +09:00 committed by GitHub
parent cbc4565b57
commit 8216d2be98
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 3 deletions

View file

@ -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 [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 |
| Articles | **Queued** see [How to submit and publish an article](./how-to-submit-and-publish-an-article). | **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 |

View file

@ -1,6 +1,8 @@
# 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).
To publish an article, you will need to create a Pull Request for a new file, formatted in Markdown, in [https://github.com/fleetdm/fleet/tree/main/articles](https://github.com/fleetdm/fleet/tree/main/articles).
> Learn how to write Fleet-flavored Markdown in our [Markdown guide](./markdown-guide).
### On this page
- [Layout](#layout)
@ -131,7 +133,7 @@ In the following example we will modify `title`, `text`, `primary-button-text`,
## Related pages
- [How to submit and publish an article](./how-to-submit-and-publish-an-article.md)
- Markdown guide (todo)
- [Markdown guide](./markdown-guide)
- Writing style guide (todo)
<meta name="maintainedBy" value="mike-j-thomas">

View file

@ -78,5 +78,10 @@ After your article is published, the Growth team will schedule your post to be p
> 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.
## Related pages
- [Article formatting guide](./article-formatting-guide)
- [Markdown guide](./markdown-guide)
- Writing style guide (todo)
<meta name="maintainedBy" value="timmy-k">
<meta name="title" value="How to submit and publish an article">