|
5 | 5 | render: 'never' |
6 | 6 | --- |
7 | 7 |
|
8 | | -Our goal is to make blogging as short and quick as we can, so we can blog often. |
9 | | -See [the template blog post](./_template-post/index.md) for an example template to use. |
10 | | - |
11 | | -## How to write blog posts |
12 | | - |
13 | | -Follow these steps: |
14 | | - |
15 | | -- Copy the `content/blog/_template-post` folder into the appopriate year folder, and modify the folder name. |
16 | | -- Modify `index.md` to fit your post. Do these things: |
17 | | - - Generate post content using the linked posts in `_template-post/index.md` as inspiration. |
18 | | - - The post should be short, to the point, and scannable. Use quick and accessible language, keep posts below 200 words. |
19 | | - - If there are links in the issue, scan their content to learn more before you write the post. |
20 | | -- Make sure to add an acknowledgements section at the bottom. Do these things: |
21 | | - - check the `/content/collaborators` folder to see if an entry exists for that collaborator, and link them if so. |
22 | | - |
23 | | - |
24 | | -### Example from Yuvi's doepy talk |
25 | | - |
26 | | -Here's an example from a recent talk that Yuvi gave: |
27 | | - |
28 | | -- Example GitHub issue: https://github.com/2i2c-org/2i2c-org.github.io/issues/470 |
29 | | -- The blog post that followed: ../../content/blog/2025/doepy-yuvi/index.md |
30 | | - |
31 | | -### Example incident report |
32 | | - |
33 | | -Incident reports are a way to provide transparency about what happened and what we learned as we run infrastructure. We create incident reports at https://github.com/2i2c-org/incident-reports so blog post GitHub issues don't need to have any content other than a link to the report. |
34 | | - |
35 | | -- Example incident report issue: https://github.com/2i2c-org/2i2c-org.github.io/issues/482 |
36 | | -- The blog post that followed: ../../content/blog/2025/incident-ucmerced-throttling |
37 | | -## How to write our Hugo directives |
38 | | - |
39 | | -Here are a few example Hugo directives for quick reference. |
40 | | - |
41 | | -### Figures |
42 | | - |
43 | | -An example figure directive: |
44 | | - |
45 | | -{{< figure src="images/staging-hub-matrix.png" title="Our staging and support hub job matrix tells GitHub Actions to deploy staging and support upgrades that act as canaries and stop production deploys if they fail.">}} |
46 | | - |
47 | | -### Videos |
48 | | - |
49 | | -From YouTube: |
50 | | - |
51 | | -{{< youtube YjonPLxDiwM >}} |
52 | | - |
53 | | -Local Videos: |
54 | | - |
55 | | -{{< video src="videos/jupyterhub-admin.mp4">}} |
56 | | - |
57 | | -### Callouts and admonitions |
58 | | - |
59 | | -An example admonition / callout: |
60 | | - |
61 | | -{{% callout %}} |
62 | | - |
63 | | -Here's some markdown in my callout! |
64 | | - |
65 | | -{{% /callout %}} |
66 | | - |
67 | | - |
68 | | -## How to add a category and tags |
69 | | - |
70 | | -Each post has one category and multiple tags. Categories describe the post's intent, and tags cover its main themes or topics. You add them to the frontmatter of posts like so: |
71 | | - |
72 | | -```markdown |
73 | | ---- |
74 | | -title: Post title |
75 | | -date: "2025-01-01" |
76 | | -categories: |
77 | | -- updates |
78 | | -tags: |
79 | | -- open source |
80 | | -- geoscience |
81 | | ---- |
82 | | -``` |
83 | | - |
84 | | -## How to use categories and tags |
85 | | - |
86 | | -We use **lowercase formatting** as well as **spaces instead of hyphens** for both tags and categories. For example, `open source`, not `open-source` and not `Open Source`. |
87 | | - |
88 | | -### Common categories |
89 | | - |
90 | | -We try to keep the number of categories small, and non-overlapping in their meaning. [Here's a list of all our categories](https://2i2c.org/categories/), but we try to keep it only to the ones below: |
91 | | - |
92 | | -- `impact` - telling stories of impact that 2i2c has had, either via contributors to a domain / open source community, or via communities we've enabled with our service. |
93 | | -- `service` - updates about our service and work we've recently done for it. |
94 | | -- `organization` - updates about our organization that isn't directly related to our service |
95 | | - |
96 | | -### Common tags |
97 | | - |
98 | | -We have a lot of tags, so don't worry about creating a new one if you don't think your tag has been covered yet. [Here's a list of all our tags](https://2i2c.org/tags/). |
| 8 | +For information about contributing to the blog, see the [blog contributing guide](../../contribute/blog.md). |
0 commit comments