Skip to content

Instantly share code, notes, and snippets.

@greglindahl
Last active August 6, 2016 12:36
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save greglindahl/d487535332cc6379198b72108868bcb0 to your computer and use it in GitHub Desktop.
Save greglindahl/d487535332cc6379198b72108868bcb0 to your computer and use it in GitHub Desktop.
Dev Portal Overview

Dev Portal Overview

Quick and Dirty

The Dev Portal was created to replace our existing API Docs on the website. New Features:

  • Searchable Docs
  • Can view the current Swagger Docs for each of our Elements
  • Docs are organized to support a more detailed explanation of Element/Product features
    • e.g. Salesforce
    • You can now send people to URLs and not worry about the side menu not opening or what not
  • Semantic URLs
    • All element docs live under docs/elements e.g /docs/elements/salesforce/index.html
    • All prodoct docs live under docs/products e.g /docs/products/element-builder/index.html

Video of Quick and Dirty: Overview

New Feature Videos

Search

Element Docs

API Toolkit

Platform

Sunset of Current Devloper Docs

The current version of our docs (http://cloud-elements.com/developer-documentation/) will be taken down on Sunday May 8th. The API DOCUMENTAITON link will be replaced with the new dev portal URL - (http://developers.cloud-elements.com/). (http://cl.ly/2v1q0f2u182A)

Reason for the New Dev Portal

Customer Feedback:

  • Current docs hard to navigate
  • Scrolling through side menu was tedius
  • Not searchable

Internal Reasons:

  • Greg is updating API Doc HTML by hand
  • The WordPress page has stopped rendering twice - this stresses Greg out very much
  • Not all engineers able to contribute
    • With new portal - it lives on GitHub and anybody can pull the repo down and contribute - much more collaborative

If you have any questions or feedback, please let me know. Your feedback is invaluable.

@Buildsoftwaresphere
Copy link

Thanks for the information at dev portal overview.

@johnlava
Copy link

johnlava commented Aug 6, 2016

Dear support team,
The new portal is good.
Best regards
john nwanja.o

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment