Here are links to articles and sample code I've authored for a wide range of audiences including software users, administrators, developers, content managers, and hobbyists.
Table of Contents:
- Product / Feature Introduction
- How-To Guides
- API Reference
- Concept Articles
- Home Pages and Doc Hierarchies
- Misc Articles
- Internal Guideline Examples
Below is a product introduction article.
- What is Apperate? describes the IEX Cloud Apperate product and how it helps you integrate data for financial tech (fintech) applications.
I created the following articles to help all kinds of audiences complete tasks.
-
Write and Read Data to Apperate using this JavaScript client library.
-
Using Asynchronous Messaging is easy to implement. Here we'll deploy an example project and examine its components.
-
Query the Financial Data API using the IEX Cloud Data API; then adjust your queries to further filter on the exact data you want.
-
Get Started with Apperate guides the user through creating a workspace, generating a dataset, and viewing the dataset's auto-generated API reference page.
-
Manage Users in IEX Cloud via the Console.
-
Load Data from an AWS S3 Bucket to Apperate for your fintech application.
-
Design a Schema for your fintech application.
-
Running Liferay for the First Time is as easy as following a few easy steps.
- Using Liferay Docker Images demonstrates starting, monitoring, and stopping Liferay Portal via Docker from the command line.
These articles show the content I created for getting started with and using the IEX Cloud API.
-
API Reference Home introduces the IEX Cloud API and uses instructions and animated GIFs to demonstrate using it.
-
Stock Quote specifies the Stock Quote endpoint including its HTTP method signature, path parameters, query parameters, and response attributes. It also includes example HTTP request URLs and links to the data bundle for purchasing access to the endpoint.
-
Basics Section provides essentials on using the API and links to important information on error codes, versioning, deprecation, and more.
These articles I wrote helped people understand some non-trivial topics.
-
Message Bus introduces programatic communication from message Senders to message Listeners via Destinations; also it introduces asynchronous and synchronous messaging approaches.
-
Architecture uses text, diagrams, and examples to explain Liferay Portal's design and benefits.
The following home / landing pages demonstrate how I've organized and presented initial product content.
-
Documentation Home Page promotes the most important IEX Cloud topics to get users where the need to go fast.
-
Leading Article and Hierarchy - The leading article introduces the IEX Cloud financial data product, shows data examples, and references content on using various financial data. The left nav provides a hierarchy of articles on using the Financial Data product, developing with it, and administering accounts.
-
API Reference Home and Hierarchy introduces the IEX Cloud API, quickstart instructions, and shows animated GIFs that demonstrate two ways of calling the API.
-
Changelog entries explain recent changes, why they were made, and how they affect IEX Cloud customers.
-
FAQs for IEX Cloud.
-
Glossary for IEX Cloud.
These internal documents I authored provide instruction on developing tutuorials and sample code, and linking the product to published articles.
- Tutorial Code Guidelines - Describes how to create a Liferay development project.
- REST API Guidelines - Demonstrates how to create scripts and classes that invoke REST API services.
- Adding Documentation Links to the Liferay UI - This guide shows technical writers how to provide links to official documentation and shows developers how to use the links in the Liferay UI's JSP code.
For more articles I wrote, including guides for system administrators, developers, and users, see Additional Articles