Skip to content

Commit

Permalink
Mark Public Functions as Coming Soon (#257)
Browse files Browse the repository at this point in the history
* Update demos.md

* Update create-function.md

* Update public-functions.md

* Update README.md

* Update roadmap.md

* Update create-automation.md
  • Loading branch information
jsdbroughton authored Dec 3, 2024
1 parent 57bf26a commit 0e0f2f4
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 36 deletions.
8 changes: 4 additions & 4 deletions automate/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# What is Automate?

Speckle Automate is a fully fledged CI/CD platform designed to run custom code on Speckle models, every time a new version is available.
Speckle Automate is a fully fledged CI/CD platform designed to run custom code on Speckle models whenever a new version is available.

<img width="1141" alt="image" src="https://github.com/user-attachments/assets/bcbfdddc-1536-4142-bcbb-9fb5a899ceb5">


As a software developer you can [develop Functions](/create-function) that others in your team consume in what we call [Automations](create-automation). From creating reports, running code compliance checks or wind simulations, there is no limit to what you can do with Automate.
As a software developer, you can [develop Functions](/create-function) that others in your team consume in what we call [Automations](create-automation). From creating reports to running code compliance checks to wind simulations, there is no limit to what you can do with Automate.


Our team as also developed a set of **Public Functions** available to all users on [app.speckle.systems](https://app.speckle.systems) that you can use to see the power of Automate.
### Coming Soon
Our team will curate a set of **Public Functions** available to all users on [app.speckle.systems](https://app.speckle.systems), which you can use to experience the power of Automate.


::: tip 🚧 NOTE
Expand Down
2 changes: 1 addition & 1 deletion automate/create-automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Automations are created from the **Automations** tab within a project.
![the automations tab](./img/automations-tab.png)

::: tip 💡 **Function Availability**
The library view includes both public functions and any private functions created for the Workspace if the project is a Workspace project created for your team. This ensures all team-specific and public resources are accessible during automation setup.
The library view includes both public functions [Coming Soon] and any private functions created for the Workspace if the project is a Workspace project created for your team. This ensures all team-specific and public resources are accessible during automation setup.
:::

### Steps to Create an Automation
Expand Down
13 changes: 6 additions & 7 deletions automate/create-function.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Creating Functions

If you have a verified account on [app.speckle.systems](https://app.speckle.systems), navigate to [app.speckle.systems/functions](https://app.speckle.systems/functions).

You will see the Functions Library. In the top right, there is a **New Function** button:
If you have a verified account on [app.speckle.systems](https://app.speckle.systems), navigate to a Workspaces-hosted project where you are a collaborator. Go to the Automations tab and select View Functions to see your team's existing functions. To create a new function, click New Function in the top right:
![new function button](./img/new-function-button.png)

This launches the function creation wizard.
Expand All @@ -16,7 +14,7 @@ This launches the function creation wizard.
![authorise github](./img/authorise-github.png)

::: tip 💡 **Authorized OAuth Apps**
Speckle Automate will appear under your GitHub account's Authorized OAuth Apps. Access can be revoked at any time but will be necessary to publish new functions.
Speckle Automate will appear under your GitHub account's Authorized OAuth Apps. Access can be revoked at any time, but it is necessary to publish new functions.
![authorised applications](./img/authorised-applications.png)
:::

Expand All @@ -30,6 +28,7 @@ This launches the function creation wizard.
- **Description** [required]: A short Markdown-supported description used in the functions list.
- **Source Application Data Supported** [optional]: Indicate which source applications your function is designed for.
- **Tags** [optional]: You can further categorise your function with single or multi-word tags, e.g., `Solar_Panels`.
- **Organisation**: Within Github, if your team works within an organisation, you can select that here.
- **Click Next**: The wizard will create your function project on GitHub.

::: tip 🧙‍♂️ **Wizard Actions**
Expand All @@ -43,9 +42,9 @@ This launches the function creation wizard.
:::

4. **Repository Management**
The function wizard creates a GitHub repository under your account.
- **Public vs Private**: Whether to keep this repository public or private depends on your team's open-source or source-available development approach. Speckle Automate supports both public and private repositories.
- **Personal or Organisational Accounts**: Depending on your setup and collaboration needs, you can publish functions from either your personal GitHub account or an organisation's account.
The function wizard creates a private GitHub repository under your account.
- **Public vs Private**: Whether you keep this repository private or make it public depends on your team's open-source or source-available development approach. Speckle Automate supports both public and private repositories.
- **Personal or Organisational Accounts**: Depending on your setup and collaboration needs, you can publish functions from your GitHub account or an organisation's account. Your published function can also be moved from one to the other.

::: tip 💡 **Important**
Carefully manage repository access based on your team's workflows and requirements.
Expand Down
5 changes: 1 addition & 4 deletions automate/demos.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
### Function Demonstrations from SpeckleCon 2023
[Speckle Automate DEMOS 🔥 - SpeckleCon 2023](https://youtu.be/BuyUvIVUO2g)

## Public Functions: Fully Functional Demonstrations
## Public Functions: Fully Functional Demonstrations [_COMING SOON_]

Public functions in the Speckle Automate Functions Library are designed to serve as both fully functional solutions and practical demonstrations of how Speckle Automate can be used effectively. They are:

Expand All @@ -24,6 +24,3 @@ These functions reflect Speckle Automate's flexibility and power, offering users
Speckle-authored demo functions are continually updated to reflect changes to the SDKs and expand functionality. While not all demo functions are available in the Functions Library, all Speckle-authored functions are published to GitHub alongside our open-source repositories.

These functions are typically namespaced under `speckle-automate-*` to facilitate discovery and reuse.

Explore the latest Automate functions here:
[All Functions - Speckle Automate](https://app.speckle.systems/functions)
36 changes: 17 additions & 19 deletions automate/public-functions.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,47 @@
# Public Functions
# Public Functions (Coming Soon)

## What Are Public Functions?

Public functions are reusable, pre-defined operations available to all Speckle Automate users. They are designed to be simple yet powerful, focusing on specific, high-utility use cases. They help streamline workflows without requiring custom development.
Public functions are reusable, pre-defined operations designed to help all Speckle Automate users streamline their workflows without needing custom development. They focus on specific, high-utility use cases and offer simplicity and efficiency.

Public functions are ideal for:
Public functions will be ideal for:

- Automating repetitive tasks.
- Solving well-defined problems efficiently.
- Providing quick-start solutions for everyday automation needs.

## Curated by Speckle

At the start of the public beta, all public functions are curated and developed by Speckle to ensure reliability, simplicity, and quality. Later in the beta, we plan to expand this ecosystem by promoting:
Public functions are planned for release soon. When introduced, Speckle will curate and develop all public functions to ensure reliability, simplicity, and quality. Over time, the ecosystem will grow to include:

- **Community Contributions**: Functions designed and shared by Speckle users.
- **Third-Party Integrations**: Functions tailored to specific use cases, such as connecting with SaaS platforms.

The goal is to create a collaborative and diverse library of functions that address a wide range of automation scenarios.

## How to Access Public Functions
## Accessing Public Functions

Public functions are accessible through the **Functions Library**, located in the Automations tab of your project.
Once released, public functions will be accessible through the **Functions Library** in the Automations tab of your project.

![function-library-view](./img/function-library-card.png)

In the library, you can:
In the library, you will be able to:

1. Browse available public functions.
2. Review descriptions to understand their purpose and parameters.
3. Select a function to include in your automation.

## Using Public Functions

To use a public function in your workflow, follow the steps outlined in the [Creating Automations](./create-automation.md) page. This guide will walk you through:
To use a public function, you'll follow these steps (available after release):

1. Selecting a public function.
2. Configuring its parameters.
3. Assigning it to a model in your project.
1. Select a public function.
2. Configure its parameters.
3. Assign it to a model in your project.

Refer to the automation pages for details on managing automations and updating configurations as needed.
The [Creating Automations](./create-automation.md) page will provide detailed guidance on creating automation and configuring functions.

## Examples of Public Functions
## Planned Examples of Public Functions

Here are some examples of public functions that offer high utility for common tasks:
Here are examples of public functions planned for release:

- **Render Image**: Produces high-quality rendered images of models.
- **Data Validator**: Ensures model data meets predefined standards.
Expand All @@ -52,10 +50,10 @@ Here are some examples of public functions that offer high utility for common ta

## Updates to Public Functions

Speckle maintains and updates Public functions to improve functionality or address issues. When a new version of a public function is released:
Speckle will maintain and update public functions to improve functionality or address issues. When a new version of a public function is released:

- Existing automations using the function will not update automatically.
- You can manually update your automation to use the latest version. Refer to the [Update an Automation](./update-automation.md) page for guidance.
- Manual updates can be applied following the [Update an Automation](./update-automation.md) guide.

## Benefits of Public Functions

Expand All @@ -64,6 +62,6 @@ Speckle maintains and updates Public functions to improve functionality or addre
- **Collaborative**: Leverage improvements from Speckle, the community, and third-party developers.
- **Efficient**: Save time with pre-configured, reliable workflows.

Public functions empower you to tackle specific challenges easily, offering a straightforward entry point to Speckle Automate's power.
Public functions aim to empower users to tackle specific challenges easily, providing a straightforward entry point to Speckle Automate's capabilities.

For more information on creating your private functions, visit the [Create Functions](./create-function.md) page.
2 changes: 1 addition & 1 deletion automate/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ We are now in the Public Beta phase, focusing on validating Automate as a robust
1. **Full Integration**: Automations are now fully integrated into the Speckle web application ([app.speckle.systems](https://app.speckle.systems)), enabling workflows against live production data.
2. **Private Functions**: Secure private function development is now available within Workspaces, addressing the need for tailored organisational workflows.
3. **Multi-Model Triggers**: Automations can respond to changes across multiple models, enabling dynamic, interconnected workflows.
4. **Discoverable Public Functions**: A curated library of Speckle-authored public functions is now searchable and available to all users.
4. **Discoverable Public Functions** [Coming Soon]: A curated library of Speckle-authored public functions is now searchable and available to all users.

This phase is critical for validating the product’s readiness for broader adoption and addressing the blockers identified in earlier stages.

Expand Down

0 comments on commit 0e0f2f4

Please sign in to comment.