Skip to content

Commit

Permalink
minor touches (#256)
Browse files Browse the repository at this point in the history
  • Loading branch information
teocomi authored Dec 3, 2024
1 parent 5b0b9f0 commit 57bf26a
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 11 deletions.
4 changes: 1 addition & 3 deletions .vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ module.exports = {
{
title: 'Automations',
collapsable: false,
children: ['create-automation', 'update-automation', 'viewing-results'],
children: ['create-automation', 'update-automation', 'viewing-results', 'troubleshooting'],
},
{
title: 'Functions',
Expand All @@ -292,8 +292,6 @@ module.exports = {
'demos',
'frequently-asked-questions',
'feedback',
'roadmap',
'troubleshooting',
'known-issues',
],
},
Expand Down
19 changes: 12 additions & 7 deletions automate/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# Speckle Automate Public Beta
# 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.

<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.


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.


::: tip 🚧 NOTE
Speckle Automate has entered the public beta phase and is now available on the Speckle production server: [app.speckle.systems](https://app.speckle.systems). These docs are a work in progress and are updated regularly to reflect the latest features and improvements.
:::

This documentation is designed to assist Speckle Automate users in creating and managing automation. As a Speckle user, you can now act as an **Automator**, leveraging public functions and creating custom workflows to streamline tasks and enhance productivity.

### Key Highlights:
- **Public Functions**: Available to all users on [app.speckle.systems](https://app.speckle.systems).
- **Private Functions**: Creatable and manageable within Workspaces.
- **Unified Hosting**: All data, functions, and automations are hosted on the main Speckle server.
- **Collaboration**: Workspace members can use public and private functions to create automations collaboratively.

We are continuously improving the documentation. As Speckle Automate evolves, there may be occasions when development temporarily outpaces the documentation. If you have any questions, please contact us on the [Speckle Community Forum: Automate](https://speckle.community/c/making-speckle/insiders-automate/27).
2 changes: 1 addition & 1 deletion automate/important-caveats.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Your Data

The development server ([latest.speckle.systems](http://latest.speckle.systems)) is no longer in use. All data, functions, and automations are now hosted on the main production server ([app.speckle.systems](https://app.speckle.systems)).
Automate is currently only available on the main production server ([app.speckle.systems](https://app.speckle.systems)).

While project data is handled with the same level of care and security as all Speckle servers note that:
- During the beta phase, Speckle reserves the right to modify or reset the Automate Execution Engine, Function library or other enabling parts of the server infrastructure. However, the data held on the server is secured and maintained.
Expand Down

0 comments on commit 57bf26a

Please sign in to comment.