Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorporate a high-level step-by-step guide and chunk the documentation up into these logical sections #2

Open
keithmoss opened this issue May 22, 2017 · 0 comments
Assignees

Comments

@keithmoss
Copy link

High-level step-by-step guide

Step-by-step Guide

Expand the current introduction to frame each section like a step-by-step guide with a 2 - 3 sentence explanation of each step and the options we'll discuss further in the guide.

  1. Exporting your data
  2. Preparing your data to load into Self-Service
  3. Uploading data into Self-Service
  4. Automating data extract and uploading

Diagram

Create a diagram that represents these steps visually to include in the introduction.

Recommended Approach

If possible, let's provide a 'Recommended Approach' section at the top.

e.g. We recommend you use FileGDBs as your format, use AWS CLI to upload, and automate with Task Scheduler/Cron jobs.

Chunk the documentation up into these logical sections

Section Intro

(You've pretty much already done this.)

For each section let's provide a roughly paragraph-sized plain English summary of what this step involves and what the options are. This should be an expanded version of what was written in the introduction at the top of the page.

Include visual where you can e.g. Uploading data to Self-Service could have FME, Python, and AWS CLI logos alongside each other to be clear what the options are.

Restrictions/Limitations/Gotchas

Add a block to each section that clearly calls out the restrictions/limitations/gotchas for it.

e.g. Zip file names may be called anything, but the shapefile name/FeatureClass name must exactly match what is in Self-Service

e.g. Only the first FeatureClass will be considered. Everything else will be ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants