[PLATFORM-1267] Updating the dev site to add new guides (#23)

* Initial commit of the getting started guide * Adding the images and gif resources. * Updated landing page and getting started guide * Attempted to fix linter complaints * Added final newline to address remaining linter complaint * Fixed relative links to api reference guide. * Getting rid of the anchor tag in link to reference guide because it seems to be tripping up the internal link validator. --------- Co-authored-by: Reena Agrawal <reagrawa@Reenas-MacBook-Pro.local>
AdobeDocs · Oct 9, 2024 · 463f3da · 463f3da
1 parent 88d78d3
commit 463f3da
Show file tree

Hide file tree

Showing 20 changed files with 247 additions and 581 deletions.
diff --git a/gatsby-config.js b/gatsby-config.js
@@ -35,26 +35,8 @@ module.exports = {
     ],
     subPages: [
       {
-        title: 'Get Started',
+        title: 'Getting Started',
         path: '/guides/',
-        pages: [
-          {
-            title: 'Dummy an OAuth Client',
-            path: '/guides/dummy_oauth_client/'
-          },
-          {
-            title: 'Dummy OAuth using POSTMAN',
-            path: '/guides/dummy_using_postman/'
-          }
-        ]
-      },
-      {
-        title: 'Frame.io API',
-        path: '/guides/api/'
-      },
-      {
-        title: 'Migrating',
-        path: '/guides/migrating/'
       }
     ]
   },

diff --git a/src/pages/guides/api/index.md b/src/pages/guides/api/index.md
diff --git a/src/pages/guides/dummy_oauth_client/index.md b/src/pages/guides/dummy_oauth_client/index.md
diff --git a/src/pages/guides/dummy_using_postman/index.md b/src/pages/guides/dummy_using_postman/index.md
diff --git a/src/pages/guides/image_1.png b/src/pages/guides/image_1.png
diff --git a/src/pages/guides/image_10.png b/src/pages/guides/image_10.png
diff --git a/src/pages/guides/image_2.png b/src/pages/guides/image_2.png
diff --git a/src/pages/guides/image_3.png b/src/pages/guides/image_3.png
diff --git a/src/pages/guides/image_4.png b/src/pages/guides/image_4.png
diff --git a/src/pages/guides/image_5.png b/src/pages/guides/image_5.png
diff --git a/src/pages/guides/image_6.png b/src/pages/guides/image_6.png
diff --git a/src/pages/guides/image_7.png b/src/pages/guides/image_7.png
diff --git a/src/pages/guides/image_8.png b/src/pages/guides/image_8.png
diff --git a/src/pages/guides/image_9.png b/src/pages/guides/image_9.png
diff --git a/src/pages/guides/index.md b/src/pages/guides/index.md
diff --git a/src/pages/guides/migrating/index.md b/src/pages/guides/migrating/index.md
diff --git a/src/pages/guides/trigger_asset_created_webhook.gif b/src/pages/guides/trigger_asset_created_webhook.gif
diff --git a/src/pages/guides/webhook_creation_sample.gif b/src/pages/guides/webhook_creation_sample.gif
diff --git a/src/pages/guides/webhook_site_example.gif b/src/pages/guides/webhook_site_example.gif
diff --git a/src/pages/index.md b/src/pages/index.md
@@ -15,33 +15,39 @@ Frame.io customers can use our new V4-compatible REST API and webhooks to power
 
 #### Resources
 
-* [Quickstart Guide](https://developer.adobe.com)
+* [Quickstart Guide](./guides/)
 * [Frame.io API Docs Github Repo](https://github.com/AdobeDocs/frameio-api)
 
 ## Overview
 
-This documentation provides instructions for Frame.io APIs. For working with Frame.io APIs, see [Frame.io API Documentation](https://github.com/AdobeDocs/frameio-api).
+### About Frame.io
 
-## Discover
+Frame.io provides a flexible, fast and intuitive platform that empowers creative teams and their stakeholders to organize, review and manage work in progress assets, and orchestrate the people and processes supporting them. Anchored in an all-new, powerful metadata framework, teams can now use Frame.io to customize any creative workflow centered on media assets.
 
-<DiscoverBlock width="100%" slots="heading, link, text"/>
+### Frame.io V4 API Requirements
 
-### Get Started
+To use the endpoints described here, you must first have a provisioned Frame.io V4 account administered via the Adobe Admin Console. If your account is on legacy version of Frame.io, please refer to our [legacy Developer Documentation](https://developer.frame.io/docs/).
 
-[Quickstart Guide](guides/)
+### About Frame.io V4 Developer Platform
 
-Get started with the Frame.io APIs.
+The Frame.io developer platform has been redesigned from the ground up to make creative collaboration clear and simple. New concepts that will make your creative life easier include role-based access controls, custom fields to fit the way your team works, and the simplification of Shares. We designed the brand new API that you interact and build with to best suit our customer and partner needs.
 
-<DiscoverBlock slots="heading, link, text"/>
+In these docs you’ll find a comprehensive Getting Started Guide that walks you through core concepts and details the full V4 API surface area– paying special attention to any differences for those migrating from V3. We’ve also included human and machine-readable API Reference documentation. Generated using the Open API specification, developers can refer to the Frame.io API Reference for a full list of supported endpoints with sample requests and responses, including error information. In the top nav of the website, developers can switch between versions where we’ll be surfacing an ‘experimental’ version for anyone looking to peak into new endpoints still under active development. Endpoints in this section should be referenced directionally only, as the routes and response bodies are subject to change before officially released under a supported version header.
 
-### API References
+### Support
 
-[OpenAPI](api/)
+If you need additional support beyond what’s covered in these documents, please reach out to the Frame.io Support Team for assistance by chatting with us on our [Support Site](https://support.frame.io/en/) . Please note that Enterprise customers may be directed to their Customer Success Manager.
+
+## Discover
+
+* * *
+
+### Get Started
 
-Explore, make calls, with full endpoint descriptions.
+[Getting Started guide](./guides/)
+Get started with the Frame.io API.
 
-## Contributing
+### API Reference
 
-We encourage you to participate in our open documentation initiative, if you have suggestions, corrections, additions
-or deletions for this documentation, check out the source from [this github repo](https://github.com/AdobeDocs/frameio-api), and submit a pull
-request with your contribution. For more information, refer to the contributing page.
+[API Reference Documentation](./api/current/)
+Explore and make calls with full endpoint descriptions.