feat: Added loads of documentation, better organization, openapi for …

…flyte-api

Writerside/c.list

@@ -2,5 +2,5 @@
 <!DOCTYPE categories
         SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
 <categories>
-    <category id="wrs" name="Writerside documentation" order="1"/>
+    <category id="home" name="Flyte Information" order="1"/>
 </categories>

Writerside/flyte.tree

@@ -7,30 +7,30 @@
                  start-page="Home.md">
 
     <toc-element topic="Home.md"/>
-    <toc-element topic="flyte-api.md">
-        <toc-element topic="API-quickstart.md"/>
-        <toc-element topic="API-reference.md">
-            <toc-element topic="Pet.md"/>
-            <toc-element toc-title="Store">
-                <toc-element topic="Returns-pet-inventories-by-status.md"/>
-                <toc-element topic="Place-an-order-for-a-pet.md"/>
-                <toc-element topic="Find-purchase-order-by-ID.md"/>
-                <toc-element topic="Delete-purchase-order-by-ID.md"/>
-            </toc-element>
-            <toc-element toc-title="User">
-                <toc-element topic="Create-user.md"/>
-                <toc-element topic="Creates-list-of-users-with-given-input-array.md"/>
-                <toc-element topic="Logs-user-into-the-system.md"/>
-                <toc-element topic="Logs-out-current-logged-in-user-session.md"/>
-                <toc-element topic="Get-user-by-user-name.md"/>
-                <toc-element topic="Update-user.md"/>
-                <toc-element topic="Delete-user.md"/>
-            </toc-element>
+    <toc-element topic="Flyte-API.md">
+        <toc-element topic="Guilds-Endpoint.md"/>
+        <toc-element topic="Users-Endpoint.md"/>
+        <toc-element toc-title="Status">
+            <toc-element topic="Get-Flyte-Status.md"/>
         </toc-element>
-        <toc-element topic="Changes.md"/>
-        <toc-element topic="api-docs.md"/>
     </toc-element>
-    <toc-element topic="automation-scripts.md">
-        <toc-element topic="Ptero-Eggs.md"/>
+
+    <toc-element topic="Other-Projects.md">
+
+    <toc-element toc-title="Github Actions">
+
+        <toc-element topic="Ptero-Build-Flow.md"/>
+    </toc-element>
+
+    <toc-element toc-title="Libraries">
+
+        <toc-element topic="Neptune.md"/>
+        <toc-element topic="Twilight.md"/>
+    </toc-element>
+
+        <toc-element toc-title="Plugins">
+
+    </toc-element>
+
     </toc-element>
 </instance-profile>

Writerside/openapi.yaml

@@ -359,7 +359,7 @@ paths:
         - store
       summary: Find purchase order by ID
       x-swagger-router-controller: OrderController
-      description: For valid response try integer IDs with value less than 5 or > 10. Other values
+      description: For valid response try integer IDs with value less than 5 or > 10. other values
         will generate exceptions.
       operationId: getOrderById
       parameters:
@@ -800,4 +800,4 @@ components:
     api_key:
       type: apiKey
       name: api_key
-      in: header
+      in: header

Writerside/redirection-rules.xml

@@ -26,4 +26,28 @@
         <description>Created after removal of "Changes" from API Docs</description>
         <accepts>Changes-XML.html</accepts>
     </rule>
+    <rule id="5603b5be">
+        <description>Created after removal of "Status Endpoint" from Flyte Documentation</description>
+        <accepts>Status-Endpoint.html</accepts>
+    </rule>
+    <rule id="4efd8ca6">
+        <description>Created after removal of "User" from Flyte Documentation</description>
+        <accepts>User.html</accepts>
+    </rule>
+    <rule id="7807ec9f">
+        <description><![CDATA[Created after removal of "<Empty-MD-Topic.md>" from Flyte Documentation]]></description>
+        <accepts>Empty-MD-Topic.html</accepts>
+    </rule>
+    <rule id="630c4b6f">
+        <description>Created after removal of "Find pet inventories by status" from Flyte Documentation</description>
+        <accepts>Returns-pet-inventories-by-status.html</accepts>
+    </rule>
+    <rule id="4369d7d1">
+        <description>Created after removal of "Get Flyte service by ID" from Flyte Documentation</description>
+        <accepts>Get-Flyte-service-by-id.html</accepts>
+    </rule>
+    <rule id="76d5324e">
+        <description>Created after removal of "Hangar Wrapper" from Flyte Documentation</description>
+        <accepts>Hangar-Wrapper.html</accepts>
+    </rule>
 </rules>

Writerside/topics/Home.md

@@ -1,54 +1,39 @@
-# Flyte Documentation
+# Flyte Documentation Home
 
 <!--Writerside adds this topic when you create a new documentation project.
 You can use it as a sandbox to play with Writerside features, and remove it from the TOC when you don't need it anymore.-->
 
-## Add new topics
-You can create empty topics, or choose a template for different types of content that contains some boilerplate structure to help you get started:
+## Start By Clicking A Topic On The Left
+You will find all the topics in the left sidebar. These topics are organized in a tree structure. Click on a topic to see its subtopics.
+
+
+## Major Changes
+## October 2023
+
+<table>
+<tr>
+<td>Topic</td>
+<td>Changes</td>
+</tr>
+<tr>
+<td>Documentation Release</td>
+<td>Documentation has been deployed publicly</td>
+</tr>
+<tr>
+<td><a href="Get-Flyte-Status.md">Flyte <code>/status</code> Endpoints Added</a></td>
+<td>
+<list>
+<li>added the <code>status</code> field</li>
+</list>
+</td>
+</tr>
+</table>
 
-## Write content
-%product% supports two types of markup: Markdown and XML.
-When you create a new help article, you can choose between two topic types, but this doesn't mean you have to stick to a single format.
-You can author content in Markdown and extend it with semantic attributes or inject entire XML elements.
-
-## Inject XML
-For example, this is how you inject a procedure:
-
-## Add interactive elements
-
-### Tabs
-To add switchable content, you can make use of tabs (inject them by starting to type `tab` on a new line):
-
-### Collapsible blocks
-Apart from injecting entire XML elements, you can use attributes to configure the behavior of certain elements.
-For example, you can collapse a chapter that contains non-essential information:
-
-#### Supplementary info {collapsible="true"}
-Content under such header will be collapsed by default, but you can modify the behavior by adding the following attribute:
-`default-state="expanded"`
-
-### Convert selection to XML
-If you need to extend an element with more functions, you can convert selected content from Markdown to semantic markup.
-For example, if you want to merge cells in a table, it's much easier to convert it to XML than do this in Markdown.
-Position the caret anywhere in the table and press <shortcut>Alt+Enter</shortcut>:
-
-## Feedback and support
-Please report any issues, usability improvements, or feature requests to our
-<a href="https://youtrack.jetbrains.com/newIssue?project=WRS">YouTrack project</a>
-(you will need to register).
-
-You are welcome to join our
-<a href="https://join.slack.com/t/writerside/shared_invite/zt-1hnvxnl0z-Nc6RWXTppRI2Oc566vumYw">public Slack workspace</a>.
-Before you do, please read our [Code of conduct](https://plugins.jetbrains.com/plugin/20158-writerside/docs/writerside-code-of-conduct.html).
-We assume that you’ve read and acknowledged it before joining.
-
-You can also always send an email to [[email protected]](mailto:[email protected]).
 
 <seealso>
-    <category ref="wrs">
-        <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/markup-reference.html">Markup reference</a>
-        <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/manage-table-of-contents.html">Reorder topics in the TOC</a>
-        <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/local-build.html">Build and publish</a>
-        <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/configure-search.html">Configure Search</a>
+    <category ref="home">
+        <a href="https://flyte.gg">Flyte GitHub Page</a>
+        <a href="https://github.com/flytegg/flyte-docs">Documentation GitHub Repository</a>
+        <a href="mailto:[email protected]">Send An Email</a>
     </category>
 </seealso>

Writerside/topics/flyte/flyteapi/Flyte-API.md

@@ -0,0 +1,4 @@
+# Flyte API
+
+<!-- This document describes how to start using your API: authorization, authentication, accessing API resources. -->
+In this section, you'll find a step-by-step guide to quickly start using the API.

Writerside/topics/flyte/flyteapi/Guilds-Endpoint.md

@@ -0,0 +1,2 @@
+# Guilds Endpoint
+

Writerside/topics/automation-scripts.md → Writerside/topics/flyte/flyteapi/Users-Endpoint.md

@@ -1,3 +1,3 @@
-# Automation Scripts
+# Users Endpoint
 
 Start typing here...

Writerside/topics/flyte/flyteapi/endpoints/status/Get-Flyte-Status.md

@@ -0,0 +1,4 @@
+# Get status of all Flyte services
+
+<api-endpoint openapi-path="./openapi.yaml" endpoint="/status" method="get"/>
+<api-endpoint openapi-path="./openapi.yaml" endpoint="/status" method="post"/>

Writerside/topics/flyte/flyteapi/endpoints/status/openapi.yaml

@@ -0,0 +1,74 @@
+openapi: 3.0.1
+info:
+  title: Flyte API
+  description: API description in Markdown.
+  version: 0.0.1
+servers:
+  - url: 'https://api.flyte.gg/v1'
+paths:
+  /status:
+    get:
+      summary: View status of all Flyte services.
+      description: View status of all Flyte services in one endpoint.
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/StatusCheck'
+
+    post:
+      summary: Update status of a Flyte service.
+      description: Update status of a Flyte service.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/IndividualStatus'
+
+      responses:
+        '201':
+          description: Created
+
+components:
+  schemas:
+    IndividualStatus:
+      type: object
+      properties:
+        id:
+          type: string
+        name:
+          type: string
+        healthy:
+          type: boolean
+
+    StatusCheck:
+      type: object
+      properties:
+        healthy:
+          type: boolean
+        dependencies:
+          type: array
+          items:
+            type: object
+            properties:
+                id:
+                  type: string
+                name:
+                    type: string
+                healthy:
+                    type: boolean
+
+
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+
+security:
+  - bearerAuth: []
+
+

Writerside/topics/flyte/other/Other-Projects.md

@@ -0,0 +1,6 @@
+# Other-Projects
+
+This topic contains projects under Flyte which do not fit inside a larger category.
+These consist of GitHub Actions, Libraries for Spigot, API Wrappers, etc.
+
+All documentation is open source, please see: [Flyte Documentation Repo](https://github.com/flytegg/flyte-docs)