You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: community/write-a-blog-post/index.html
+9-9
Original file line number
Diff line number
Diff line change
@@ -346,10 +346,10 @@ <h2 id="writing-tips">Writing tips</h2><p><strong>Structuring posts about your p
346
346
<pclass="text-muted"><em>If you have more tips, <ahref="https://github.com/creativecommons/vocabulary/blob/main/content/community/write-a-blog-post/contents.lr">submit an edit to this page</a>.</em></p><h2id="how-to-post">How to post</h2><p>Once you have written your post, you can either send it to us (Markdown is easiest for us, but we're happy to work with other formats) or directly create a pull request for your post as detailed below.</p>
347
347
<p><ahref="/contributing-code/pr-guidelines/">Pull requests</a> should be submitted to the <strong><ahref="https://github.com/creativecommons/creativecommons.github.io-source">creativecommons.github.io-source</a> repository</strong>. The CC Open Source site is built using the static site generator <ahref="https://www.getlektor.com/">Lektor</a> and your blog post must follow the specific format documented below to appear correctly on the site. For example, please see <ahref="https://github.com/creativecommons/creativecommons.github.io-source/commit/eac3fbc23b7cadb58fe49d3af3286e4c8bf20d2f">this commit adding a post</a>.</p>
348
348
<ol>
349
-
<li>Each blog entry lives in its own subdirectory of the <ahref="https://github.com/creativecommons/creativecommons.github.io-source/tree/master/content/blog/entries">content/blog/entries</a> folder. Create a new subdirectory with a <ahref="https://blog.tersmitten.nl/slugify/">slugified</a> version of your blog post title.</li>
349
+
<li>Each blog entry lives in its own subdirectory of the <ahref="https://github.com/creativecommons/creativecommons.github.io-source/tree/main/content/blog/entries">content/blog/entries</a> folder. Create a new subdirectory with a <ahref="https://blog.tersmitten.nl/slugify/">slugified</a> version of your blog post title.</li>
350
350
<li>Create a file named <code>contents.lr</code> in the subdirectory you just created. This is the file that will contain your blog post content.</li>
351
351
<li>If your post uses images or other files, put them in the same subdirectory as the <code>contents.lr</code> file.</li>
352
-
<li><p>Fill in <code>contents.lr</code> in the following format (<ahref="https://raw.githubusercontent.com/creativecommons/creativecommons.github.io-source/master/content/blog/entries/open-development-with-saltstack/contents.lr">see example post</a>):</p>
352
+
<li><p>Fill in <code>contents.lr</code> in the following format (<ahref="https://raw.githubusercontent.com/creativecommons/creativecommons.github.io-source/main/content/blog/entries/open-development-with-saltstack/contents.lr">see example post</a>):</p>
353
353
<pre>
354
354
<code>
355
355
title: Replace this text with the title of your blog post
@@ -370,25 +370,25 @@ <h2 id="writing-tips">Writing tips</h2><p><strong>Structuring posts about your p
370
370
</code>
371
371
</pre><p><em>Read more about <ahref="https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet">Markdown formatting here</a>.</em></p>
372
372
</li>
373
-
<li>Create category pages for any new categories that you've assigned to your post. Each category has its own subdirectory in the <ahref="https://github.com/creativecommons/creativecommons.github.io-source/tree/master/content/blog/categories">content/blog/categories</a> directory.<ul>
373
+
<li>Create category pages for any new categories that you've assigned to your post. Each category has its own subdirectory in the <ahref="https://github.com/creativecommons/creativecommons.github.io-source/tree/main/content/blog/categories">content/blog/categories</a> directory.<ul>
374
374
<li>Create a folder that uses the <strong>the exact category name</strong> as the blog post with its own <code>contents.lr</code> file within.</li>
375
-
<li>The new <code>contents.lr</code> file within should follow the same format as the other categories. Here's an <ahref="https://raw.githubusercontent.com/creativecommons/creativecommons.github.io-source/master/content/blog/categories/gsoc-2019/contents.lr">example category content file</a>.</li>
375
+
<li>The new <code>contents.lr</code> file within should follow the same format as the other categories. Here's an <ahref="https://raw.githubusercontent.com/creativecommons/creativecommons.github.io-source/main/content/blog/categories/gsoc-2019/contents.lr">example category content file</a>.</li>
376
376
</ul>
377
377
</li>
378
-
<li>Similarly, if this is your first post, you'll need to create a file with author information. Each author has a subdirectory in the <ahref="https://github.com/creativecommons/creativecommons.github.io-source/tree/master/content/blog/authors">content/blog/authors</a> directory.<ul>
378
+
<li>Similarly, if this is your first post, you'll need to create a file with author information. Each author has a subdirectory in the <ahref="https://github.com/creativecommons/creativecommons.github.io-source/tree/main/content/blog/authors">content/blog/authors</a> directory.<ul>
379
379
<li>Your author folder must have <strong>the exact username</strong> as the author field of the blog post and have a <code>contents.lr</code> file within.</li>
380
380
<li>The <code>username</code> field in the <code>contents.lr</code> file should also use the same exact username.</li>
381
-
<li>The author's <code>contents.lr</code> file within should follow the same format as the other authors. Here's an <ahref="https://raw.githubusercontent.com/creativecommons/creativecommons.github.io-source/master/content/blog/authors/TimidRobot/contents.lr">example author content file</a>.</li>
381
+
<li>The author's <code>contents.lr</code> file within should follow the same format as the other authors. Here's an <ahref="https://raw.githubusercontent.com/creativecommons/creativecommons.github.io-source/main/content/blog/authors/TimidRobot/contents.lr">example author content file</a>.</li>
382
382
</ul>
383
383
</li>
384
-
<li>If your blog is part of a connected series, you'll need to make a file with series information. Each series has a subdirectory in the <ahref="https://github.com/creativecommons/creativecommons.github.io-source/tree/master/content/blog/series">content/blog/series</a> directory.<ul>
384
+
<li>If your blog is part of a connected series, you'll need to make a file with series information. Each series has a subdirectory in the <ahref="https://github.com/creativecommons/creativecommons.github.io-source/tree/main/content/blog/series">content/blog/series</a> directory.<ul>
385
385
<li>Create a folder that uses the <strong>the exact series name</strong> as the blog post with its own <code>contents.lr</code> file within.</li>
386
-
<li>The new <code>contents.lr</code> file within should follow the same format as the other series. Here's an <ahref="https://raw.githubusercontent.com/creativecommons/creativecommons.github.io-source/master/content/blog/series/gsoc-2019-vocabulary/contents.lr">example series content file</a>.</li>
386
+
<li>The new <code>contents.lr</code> file within should follow the same format as the other series. Here's an <ahref="https://raw.githubusercontent.com/creativecommons/creativecommons.github.io-source/main/content/blog/series/gsoc-2019-vocabulary/contents.lr">example series content file</a>.</li>
387
387
</ul>
388
388
</li>
389
389
<li>Build the <code>creativecommons.github.io-source</code> project locally (instructions are in the <code>README</code> in the repository) and ensure your blog post shows up correctly locally. If you have not created the appropriate category or author files, you will see a build error in this step.</li>
390
390
<li>Push your code and make a pull request.</li>
391
-
<li>Wait for a member of CC's fulltime staff to merge the post into the <code>master</code> branch.</li>
391
+
<li>Wait for a member of CC's fulltime staff to merge the post into the <code>main</code> branch.</li>
392
392
</ol>
393
393
<p>Once merged, your new post will automatically be pushed to the production site and a notification containing your post URL will be sent to the <code>#cc-developers</code> channel on Slack.</p>
0 commit comments