Merge branch 'master' of github.com:Shuffle/shuffle-docs

Author: 0x0elliot

articles/Shuffle_Open_Source.md

@@ -1,41 +1,108 @@
 ![Shuffle Open Source](https://github.com/frikky/shuffle-docs/blob/master/assets/Shuffle_Open_Source.png?raw=true)
 
-# Shuffle Open Source
+# Shuffle 🧡 Open Source
 
-Shuffle is an open source automation platform, built for and by security professionals. Security operations is complex, but it doesn't have to be.
-
-## Getting Started
-To get started with Shuffle in own infrastructure:
-
-[Go to Shuffle - Getting Started](https://shuffler.io/docs/getting_started)
+Shuffle has been open source from its inception, and we have no plans to change that. All of Shuffle's code is public, and this is so anyone can use Shuffle.
 
-## Configuration
-Understand how to get the most out of Shuffle with right configuration:
+Our business model is based on:
+- Being a part of your scaling journey
+- Providing support to make the most of the powerful Shuffle automation platform
 
-[Go to Shuffle - Configuration](https://shuffler.io/docs/configuration)
+All the [features and functionality](https://shuffler.io/docs/features) are available on Open Source, and no features are exclusive. Here's what our development cycle looks like:
+- Everything new comes to [shuffler.io](shuffler.io) first, and then onprem after thorough onprem scale testing.
+- New features come through 'nightly' branch releases almost nightly, with 'latest' branch being well tested releases.
 
-## Architecture
-Understand how and why Shuffle works:
+What you get:
+- You simply get all the features and use Shuffle as truly Open Source.
+- When you scale, is when you pay.
+- Even when you scale and pay, Shuffle will still be cheaper than any other solution on the market.
+  - This is possible due to being available in a wider market, and focus on self-service.
+- You get a win on both sides:
+  - At small to medium-sized operations, you pay nothing and get the best platform on the market.
+  - When you do pay, you get the best deal / rate on the market.
+- This simplifies your decision making. You win and make the best decision either the way.
 
-[Go to Shuffle - Architecture](https://shuffler.io/docs/architecture)
+## Open Source Resources
 
-## Features
-See all the powerful ways to automate:
+Shuffle is an open source automation platform, built for and by security professionals. Security operations is complex, but it doesn't have to be.
 
-[Go to Shuffle - Features](https://shuffler.io/docs/features)
+1. **Getting Started**. To get started with Shuffle in own infrastructure: [Go to Shuffle - Getting Started](https://shuffler.io/docs/getting_started).
 
-## Documentation
-Learn more about Shuffle platform on our public documentation:
+2. **Configuration**. Understand how to get the most out of Shuffle with right configuration: [Go to Shuffle - Configuration](https://shuffler.io/docs/configuration).
 
-[Go to Shuffle - Documentation](https://shuffler.io/docs/documentation)
+3. **Architecture**. Understand how and why Shuffle works: [Go to Shuffle - Architecture](https://shuffler.io/docs/architecture).
 
-## Final Note
-Used by 10s of thousands of users globally, Shuffle is a gateway to powerful and efficient automations.
+4. **Features**. See all the powerful ways to automate: [Go to Shuffle - Features](https://shuffler.io/docs/features).
 
-[Visit Shuffle on Github](https://github.com/Shuffle/Shuffle)
+5. **Documentation**. Learn more about Shuffle platform on our public documentation: [Go to Shuffle - Documentation](https://shuffler.io/docs/documentation).
 
 ## Disclaimer
 A couple of notes to keep in mind:
 - Shuffle is a powerful technical platform that requires technical knowledge of servers, containers, deployment, and dev-ops.
 - Shuffle Open Source is made for experts to try out the platform (projects and testing purposes).
 - If you are unsure about setting-up Shuffle yourself, we recommend [registering to use Shuffle Cloud](https://shuffler.io/register) or [contacting us](https://shuffler.io/contact) for help.
+
+## Difference between Open Source and Enteprise
+
+![Shuffle OSS vs Enterprise](https://raw.githubusercontent.com/Shuffle/shuffle-docs/refs/heads/master/assets/Shuffle%20Open%20Source%20vs%20Enterprise.png)
+
+
+## Shuffle's Open Source Business Model
+
+Our business model is open and transparentm and works on two fronts:
+
+- **Scale License:** As you grow beyond a point (refer to image above), you get an Enterprise license so that your Shuffle instance scales smoothly without any hiccups.
+  - This is done so we set the right expectations for scaling, as our inbox is full of people wanting to scale.
+  - Scaling with high availability is hard, especially if you are onprem.
+  - Hence, we have put a lot of money and resources on R&D for a scalable distributed [runtime architecture](https://shuffler.io/docs/architecture), which is what you get with an Enterprise License.
+- **Support:** Shuffle is a powerful and versatile platform, and it comes with the challenge of too many options and possibilities. When you want our help or want to make the most of Shuffle, you get a support package from Shuffle that covers:
+  - Setup (Architecture + Configuration + Onboarding)
+  - Error handling
+  - Feature Requests
+  - Workflow Development
+  - App Development
+  - And much more. Think of us as an addition to your team for using Shuffle to it's limits.
+
+## Why enforce Open Source and License on Scale?
+
+Shuffle is built on trust. People have **severly** abused it.
+
+The simple and fair solution is to enforce the trust:
+- We stay true to Open Source.
+- Provide a GREAT platform for EVERYONE with all features and zero evil built-in blockers.
+- Small companies get industry-leading platform for free, which was the core idea of Open Source.
+- Big companies get a better + cheaper platform in the industry, without a vendor-lock-in; another core idea behind Open Source.
+- Win-win for everyone.
+
+**This helps us:**
+- Keep Shuffle Open Source
+- To pay our GREAT employees
+- Reinvest in community building
+- Spend resources on R&D
+- Maintain Shuffle's technical superiority in the market
+
+## Shuffle vs Others
+
+Let's be frank:
+
+- Majority of companies who call themselves Open Source, are not truly Open Source, but Open Core.
+  - Many have hidden blockers, evil business practices, or create their own licenses.
+- We don't do that. We are truly Open Source.
+  - We do not hide any feature whatsoever, are built on the AGPLv3 license, and are completely transparent about our business model.
+
+By being lean and open source first, it has even made us able to make interesting models for top contributors to get licenses and support cheaper. 
+
+This means comparison of Shuffle-to-Others is an Apple-to-Oranges comparison at best.
+
+## Shuffle's Commitment
+
+- We have no plans to close-source Shuffle. 
+- We went hard on the first iteration of scale licensing, so that we can open up more in the future as we find the right balance between growth and friction.
+- We aim to build a fair and sustainable future for Shuffle and the Open Source community.
+
+As we are in the early phase, we appreciate any and all feedback on the approach at [email protected]
+
+**With regards**
+
+- Jay, Shuffle CTO
+- Fredrik, Founder of Shuffle

articles/Shuffle_Pricing.md

@@ -17,3 +17,19 @@ For example, the workflow below has many nodes or 'actions'. Whenever it runs, t
 IMP: Only the actions that run are counted; the rest are ignored and not counted. In the workflow below, even though it has many actions, if it stops at the (red) filter action, only 4 app-runs are counted.
 
 ![Shuffle Pricing](https://github.com/frikky/shuffle-docs/blob/master/assets/Shuffle_Pricing_Workflow.png?raw=true)
+
+## Why Shuffle Pricing Works
+
+Shuffle's pricing is market-leading. Why? Read single sentence explanations below:
+
+1. **App-Runs Based**: Shuffle's licensing cost is only based on app-runs. Everything else is unlimited
+
+2. **Cost Effective**: Shuffle's app-run pricing is the most inexpensive on the market, period.
+
+3. **Incentivizes Efficiency**: Given that app-runs are actual actions that runs inside your workflow, it incentivizes everyone to build efficient and fast automations.
+
+4. **Scale Discounts**: Shuffle offers growing discounts so that your cost does not increase linearly with increase in your scale.
+
+## Questions?
+
+Still have questions on mind? Feel free to [contact us](https://shuffler.io/contact) and we'll help you out!

articles/Why_Shuffle_Pricing_Works.md

@@ -38,6 +38,12 @@ Website: [https://singul.io](https://singul.io)
 ## Using AI in Workflows
 TBA: Coming soon
 
+### LLM inference
+TBA
+
+### Conditions
+TBA
+
 ## App generation
 App generation is a system built to generate Rest API apps from documentation URLs. It works by emulating a browser with which it crawls the documentation.
 

assets/Shuffle Features Presentation.pdf

@@ -324,10 +324,10 @@ Deletes a key, completely removing all references to it.
 
 To delete a key from a specific category, add `"category": "name"` to the JSON body.
 
-Methods: DELETE
+Methods: POST
 
 ```bash
-curl -X DELETE https://shuffler.io/api/v1/orgs/{org_id}/delete_cache  -H "Authorization: Bearer APIKEY" -d '{"org_id": "ORG_ID", "key": "hi"}'
+curl -XPOST https://shuffler.io/api/v1/orgs/{org_id}/delete_cache  -H "Authorization: Bearer APIKEY" -d '{"org_id": "ORG_ID", "key": "hi", "category": ""}'
 ```
 
 
@@ -406,7 +406,9 @@ If you want to see whether your app was uploaded or not, you can always check th
 ## Stats and Timelines
 Stats and Timelines are a system built to help track changes to something over time. This is used both by internal systems in Shuffle, and is an option for you to use in Workflows or elsewhere to make timelines. Adding statistics was added in versions >1.4.3, and graphing of ANY value will be available soon. Graphs for default tracked information like App and Workflow utilisation is on the [statistics admin page for your Organisation](https://shuffler.io/admin?admin_tab=billing). 
 
-**PS: Statistics are visible to you for every 5th number counted. This means you need to count the number 1 five times, or any number higher than 5 one time for it to be visible.**
+The [new dashboard page allows for customisation of a bar graph](/new-dashboard). You may view your custom stats here. We will introduce custom dashboard controls in future versions of Shuffle.
+
+<img width="1398" height="423" alt="image" src="https://github.com/user-attachments/assets/97212387-d376-4211-9321-157f6817b272" />
 
 ### Get Stats
 Returns the statistics for an organisation
@@ -839,7 +841,7 @@ curl https://shuffler.io/api/v1/workflows/schedules -H "Authorization: Bearer AP
 ```
 
 ### Schedule a workflow
-Schedule a workflow to run at certain intervals. The node in the workflow must exist, and that the **execution argument MUST be a string**.
+Schedule a workflow to run at certain intervals. The node in the workflow must exist, and that the **execution argument MUST be a string**. May not update the ID within a workflow.
 
 Methods: POST