jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

add guidance on scheduled workflow examples (#18417)

Browse Source
This commit is contained in:
Sarah Edwards
2021-03-25 14:16:32 -07:00
committed by GitHub
parent a9bee89188
commit e214f65cb5
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
contributing/content-style-guide.md
View File

@@ -13,6 +13,7 @@ These guidelines are specific to GitHub’s documentation. For general style que
- [Commands](#commands) - [Commands](#commands)
- [Examples](#examples) - [Examples](#examples)
- [Indentation](#indentation) - [Indentation](#indentation)
- [Scheduled workflows](#scheduled-workflows)
- [Headers](#headers) - [Headers](#headers)
- [Images](#images) - [Images](#images)
- [Alt text](#alt-text) - [Alt text](#alt-text)
@@ -145,6 +146,14 @@ In YAML examples, such as actions and workflow files, use two spaces to indent l
python-version: ${{ matrix.python }} python-version: ${{ matrix.python }}
``` ```
### Scheduled workflows
Workflow runs are delayed when too many workflows run at once. Since many users copy code from the GitHub docs, we should use examples that guide users away from congested times.
- Do not use examples that run on the hour. (The Actions team reports that times at the start of the hour, especially UTC midnight, are disproportionately overloaded.)
- Do not use examples that run more frequently than necessary. For example, instead of running every 5 minutes, consider if the example makes sense to run every 30 minutes instead.
- Use a different time for each example.
## Headers ## Headers
Use H3 for headers, and H4 for subheaders. When referring to headers, surround the header name with quotation marks. Use H3 for headers, and H4 for subheaders. When referring to headers, surround the header name with quotation marks.