Okta Developer Blog
The Okta developer blog (developer.okta.com/blog) is built using Hugo.
See a problem or want to contribute? Read Contributing to the site below.
Getting help
If you have questions or need help with Okta's APIs or SDKs, visit our Developer Forums or ask a question on Stack Overflow. If you think you've encountered a bug in one of our SDKs, please create a GitHub issue for that SDK.
Helpful resources and links
Contributing to the site
Documentation updates, bug fixes, and PRs are all welcome!
To begin, you'll need to clone this project locally and install its dependencies.
NOTE: If you're not a member of the oktadeveloper org, you'll need to fork this repo and adjust the GitHub URL accordingly.
git clone git@github.com:oktadeveloper/okta-blog.git
cd okta-blog
npm i
gem install bundler
bundle install
You'll also need to install Hugo. On macOS, you can use Homebrew: brew install hugo. See Install Hugo for other operating systems.
Then you can build the site with npm start. Visit http://localhost:1313 in your browser.
Create a new blog post
To create a new blog post, start by creating a new branch. Your branch name should indicate your post's content (e.g., spring-boot-rest-api-post) or the issue number (e.g., issue/42) from our Kanban board.
git checkout -b <branch name>
Then create a new Markdown (*.md) or AsciiDoc (*.adoc) file in content/blog. The name of the file will be the URL, so make sure you talk to Lindsay (or your Okta contact) to confirm you have the right keywords in it.
The file you create should have front matter at the top that defines metadata for the post. The date it's published on is controlled by the date line. For example:
---
layout: blog_post
title: 'Why JWTs Suck as Session Tokens'
author: rdegges
date: 2017-08-17T00:00:00Z
description: "Learn why you should never use JSON web tokens as session tokens (either in cookies or HTML local storage)."
tags: [security, jwt, token, authentication, sessions]
tweets:
- "Don't worry about the items in this list if you're not an Okta employee."
- "But you can put something in here if you think of some witty tweet! :)"
---
TIP: Make sure you add a period to the description as this will show up as a sentence when it shows up as a search result in Google.
For images in your post, you should use a regular <img> tag and control its width with a width attribute. Use the center-image style to center the image.
<img src="/img/blog/wheres-the-bacon/okta-reverentgeek.jpg"
alt="ReverentGeek and Okta = Two Greats that Go Great Together" width="800" class="center-image">Images for your post should go in a directory under themes/okta/static/img/blog. Create a new directory for your post and put your images in there. Name the directory to match your post's keywords, or simply match the URL. Hugo's root directory is at /themes/okta/static, so that's why the image path above starts with /img/blog.
Images should be sized so they're not too big. We recommend a max image size of 1600px, so it looks good on retina displays. They should be optimized as well. For macOS, we recommend ImageOptim.
NOTE: In the future, we hope to use <img srcset> to create responsive images for different screen sizes.
Once you're satisfied with your post, push it to this repo and create a pull request.
git add .
git commit -m "Add Your Awesome Post"
git push origin <branch name>
Notify the team in Slack that you're ready for your PR to be reviewed.
NOTE: Until Hugo is live, PRs should not be merged. Instead, the Markdown and images should be copied to @okta/okta.github.io. This will be handled by someone that works for Okta.