Home

Jump to bottom

Maurice Sharp (Okta) edited this page Mar 8, 2022 · 9 revisions

Welcome to the Okta Developer Docs wiki!

The updated wiki pages outline everything you need to know about this repo:

Getting set up to contribute content

Software
Local setup
Previewing the site
Running tests (after writing)
What about building the site before committing? (after writing)

Committing changes

Prereqs - install all the required software
Release-related content
- Create a release branch
- Create a working branch off of the release branch
- Push the working branch to GitHub
- Create a pull request against the release branch
All other content
- Merge into master

VuePress Authoring Guidelines

File names
Front matter
Headings
Okta URLs
API CRUD tags
Lifecycle Tags
Images
Left Side Nav
Category links

Style Guide

Terms
Acronyms and Abbreviations
Capitalization
Formatting text
Tables
JSON examples
Dates
Punctuation
Order of elements
Headings [new]
Define alt text for images/diagrams

Deploying a Doc Release

See the wiki page for a detailed look at how to deploy a doc release for weekly and monthly releases.

Creating a Guide

Prereqs - install software , create a working branch
Familiarize yourself with VuePress authoring guidelines and style guide
Adding and editing pages
Directory structure
Constructing a new guide
- Steps
- Using the "Stack Selector"
- Writing framework-specific content
- Linking between sections and guides
Theme and Plugin Contribution

Troubleshooting