Skip to content

Commit

Permalink
ENH: Add fix to blog post, add docs on how to write a blog post (#1299)
Browse files Browse the repository at this point in the history
* remove old list of colormaps

* add docs about blog post contributions
  • Loading branch information
mgrover1 authored Oct 21, 2022
1 parent d9ead58 commit cdfb279
Show file tree
Hide file tree
Showing 3 changed files with 139 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc/source/blog_posts/2022/TRACER.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1388,6 +1388,8 @@
}
],
"metadata": {
"author": "Bobby Jackson",
"date": "2022-10-21",
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
Expand All @@ -1404,7 +1406,9 @@
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.6"
}
},
"tags": "TRACER,cloud,aerosol,radar",
"title": "Blending Observations from TRACER using Py-ART"
},
"nbformat": 4,
"nbformat_minor": 5
Expand Down
125 changes: 125 additions & 0 deletions doc/source/blog_posts/blog-post-template.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
{
"cells": [
{
"cell_type": "markdown",
"id": "45cfb472-b815-4435-a25b-31da424d2344",
"metadata": {
"tags": []
},
"source": [
"# Blog Post Template\n",
"\n",
"This is a template to use for blog posts! Make sure to copy this, and paste into one of the year directories (ex. `2022`).\n",
"\n",
"**Make sure to edit the tags for this by opening this notebook with a text editor, and editing the last section that looks like this**\n",
"\n",
"You need to edit the \n",
"- [ ] Author\n",
"- [ ] Date\n",
"- [ ] Tags\n",
"- [ ] Title\n",
"\n",
"```\n",
" \"metadata\": {\n",
" \"author\": \"YOUR NAME HERE\",\n",
" \"date\": \"YYYY-MM-DD\",\n",
" \"kernelspec\": {\n",
" \"display_name\": \"Python 3 (ipykernel)\",\n",
" \"language\": \"python\",\n",
" \"name\": \"python3\"\n",
" },\n",
" \"language_info\": {\n",
" \"codemirror_mode\": {\n",
" \"name\": \"ipython\",\n",
" \"version\": 3\n",
" },\n",
" \"file_extension\": \".py\",\n",
" \"mimetype\": \"text/x-python\",\n",
" \"name\": \"python\",\n",
" \"nbconvert_exporter\": \"python\",\n",
" \"pygments_lexer\": \"ipython3\",\n",
" \"version\": \"3.9.12\"\n",
" },\n",
" \"tags\": \"list,of,tags\",\n",
" \"title\": \"INSERT TITLE HERE\"\n",
" },\n",
" \"nbformat\": 4,\n",
" \"nbformat_minor\": 5\n",
"}\n",
"```"
]
},
{
"cell_type": "markdown",
"id": "46e488d6-b188-4678-882d-658b52e8d687",
"metadata": {},
"source": [
"## Motivation\n",
"\n",
"Write about the motivation for this post here. Provide background information, and why the reader should care."
]
},
{
"cell_type": "markdown",
"id": "c43c1f1d-9a07-45fb-aa17-01d569da531c",
"metadata": {},
"source": [
"## The Problem\n",
"\n",
"Define the problem - show errors, what the issue is you are trying to solve."
]
},
{
"cell_type": "markdown",
"id": "35e16154-8b95-4696-9ac3-e73fe637e293",
"metadata": {},
"source": [
"## The Solution\n",
"Include a walk through of the solution, with some sort of final figure or notable insight!"
]
},
{
"cell_type": "markdown",
"id": "02b669b8-48eb-46e3-8688-f30db62f905d",
"metadata": {},
"source": [
"## Conclusions\n",
"\n",
"Sum up your conclusions here."
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "1c1ea1d9-3a03-420a-8ac7-1e405ab869e6",
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
"author": "YOUR NAME HERE",
"date": "YYYY-MM-DD",
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.6"
},
"tags": "list,of,tags",
"title": "INSERT TITLE HERE"
},
"nbformat": 4,
"nbformat_minor": 5
}
9 changes: 9 additions & 0 deletions doc/source/userguide/contributors_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -417,3 +417,12 @@ Appveyor and TravisCI will determine if the code past all checks. If the
code fails either tests, as the pull request sits, make changes to fix the
code and when pushed to GitHub, the pull request will automatically update
and TravisCI and Appveyor will automatically rerun.

Blog Posts
----------

You can also contribute by adding blog posts. To get started with
blog posts, check out the blog post notebook template in the
`doc/source/blog_posts/` directory. Move the blog post to a
directory with the corresponding year (ex. `2022`), and follow the
contribution process outlined above.

0 comments on commit cdfb279

Please sign in to comment.