durbok/noodl-docs
1
0
Fork 0
mirror of https://github.com/noodlapp/noodl-docs.git synced 2026-01-12 07:12:53 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: Upgrade Docusaurus from v2 to v3 (#52)

Browse Source 
* chore: Upgrade Docusaurus from v2 to v3

* chore: Update "Test build" GH workflow

* fix: build

All markdown is processed as MDX

* fix: Broken links
This commit is contained in:
Eric Tuvesson
2024-01-12 16:53:22 +01:00
committed by GitHub
parent 65b0cf0417
commit 656e5fc8d2
156 changed files with 4854 additions and 10445 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
nodes/data/user/log-in/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Log In node
---
<##head##>
{/*##head##*/}
# Log In
@@ -24,26 +24,26 @@ Once a user is logged in, their data can be accessed through the <span className
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| ------------------------------------------ | --------------------------------------------------------------------------------- |
| <span className="ndl-data">Username</span> | <##input:username##>The username of the user that should be logged in.<##input##> |
| <span className="ndl-data">Password</span> | <##input:password##>The password of the user that should be logged in.<##input##> |
| <span className="ndl-data">Username</span> | {/*##input:username##*/}The username of the user that should be logged in.{/*##input##*/} |
| <span className="ndl-data">Password</span> | {/*##input:password##*/}The password of the user that should be logged in.{/*##input##*/} |
| Signal | Description |
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal to this action to log in the user. You need to make sure the **Username** and **Password** is connected, these will be sent to the backend for authentication.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal to this action to log in the user. You need to make sure the **Username** and **Password** is connected, these will be sent to the backend for authentication.{/*##input##*/} |
## Outputs
| Signal | Description |
| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>This event will be triggered if the log in was succesful.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>This event will be triggered if something went wrong while trying to log in the user. The error message can be found in the **Error** output.<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This event will be triggered if the log in was succesful.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This event will be triggered if something went wrong while trying to log in the user. The error message can be found in the **Error** output.{/*##output##*/} |
| Data | Description |
| --------------------------------------- | ---------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Error</span> | <##output:error##>This output will contain the error message if the log in failed.<##output##> |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}This output will contain the error message if the log in failed.{/*##output##*/} |

12
nodes/data/user/log-out/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Log Out node
---
<##head##>
{/*##head##*/}
# Log Out
@@ -16,21 +16,21 @@ This node is used to log out a user from the current session. That means that th
</div>
<##head##>
{/*##head##*/}
## Inputs
| Signal | Description |
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal to this action to logout the user. The user session will be removed from the browser.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal to this action to logout the user. The user session will be removed from the browser.{/*##input##*/} |
## Outputs
| Signal | Description |
| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>This event will be triggered if the logout was succesful.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>This event will be triggered if something went wrong while trying to logout the user. The error message can be found in the **Error** output.<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This event will be triggered if the logout was succesful.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This event will be triggered if something went wrong while trying to logout the user. The error message can be found in the **Error** output.{/*##output##*/} |
| Data | Description |
| --------------------------------------- | ----------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Error</span> | <##output:error##>This output will contain the error message if the log out failed.<##output##> |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}This output will contain the error message if the log out failed.{/*##output##*/} |

16
nodes/data/user/set-user-properties/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Set User Properties node
---
<##head##>
{/*##head##*/}
# Set User Properties
@@ -17,26 +17,26 @@ This node is used to set properties on the currently logged in user.
</div>
A user needs to be logged in via either the <span className="ndl-node">Sign Up</span> node or the <span className="ndl-node">Log In</span> node. If you want to read user properties of the currently logged in user you can use the <span className="ndl-node">User</span> node.
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Email</span> | <##input:email##>This input is used to set the **Email** property.<##input##> |
| <span className="ndl-data">Your custom properties</span> | <##input:prop-\*##>A property of the **User** class. You can add additional properties to the **User** class in the Noodl Cloud Services dashboard. <##input##> These will show up as inputs on the **Set User Properties** node. |
| <span className="ndl-data">Email</span> | {/*##input:email##*/}This input is used to set the **Email** property.{/*##input##*/} |
| <span className="ndl-data">Your custom properties</span> | {/*##input:prop-\*##*/}A property of the **User** class. You can add additional properties to the **User** class in the Noodl Cloud Services dashboard. {/*##input##*/} These will show up as inputs on the **Set User Properties** node. |
| Signal | Description |
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal to this input to store the properties in the user record in the Noodl Cloud Services. Once completed the **Success** or **Failure** action will be triggered.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal to this input to store the properties in the user record in the Noodl Cloud Services. Once completed the **Success** or **Failure** action will be triggered.{/*##input##*/} |
## Outputs
| Signal | Description |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>This event will be triggered if the properties was succesfully stored.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>This event will be triggered if something went wrong while trying to store the properties on the **User** record in the Noodl Cloud Services. The error message can be found in the **Error** output.<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This event will be triggered if the properties was succesfully stored.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This event will be triggered if something went wrong while trying to store the properties on the **User** record in the Noodl Cloud Services. The error message can be found in the **Error** output.{/*##output##*/} |
| Data | Description |
| --------------------------------------- | ---------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Error</span> | <##output:error##>This output will contain the error message if the action failed.<##output##> |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}This output will contain the error message if the action failed.{/*##output##*/} |

20
nodes/data/user/sign-up/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Sign Up node
---
<##head##>
{/*##head##*/}
# Sign Up
@@ -24,28 +24,28 @@ The <span className="ndl-node">Sign Up</span> node is the easiest way to handle
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Username</span> | <##input:username##>This is the username of the new user that is going to sign up. It is required that this input has a value and it must be unique, or the sign up will fail.<##input##> |
| <span className="ndl-data">Password</span> | <##input:password##>This input should contain the password for the new user.<##input##> |
| <span className="ndl-data">Email</span> | <##input:email##>Optionally the new user can be given assigned an email.<##input##> |
| <span className="ndl-data">Your custom properties</span> | <##input:prop-\*##>A property of the **User** class. You can add additional properties to the **User** class in the Noodl Cloud Services dashboard. <##input##> These will show up as inputs on the **Sign Up** node to optionally bhe given a value during sign up. |
| <span className="ndl-data">Username</span> | {/*##input:username##*/}This is the username of the new user that is going to sign up. It is required that this input has a value and it must be unique, or the sign up will fail.{/*##input##*/} |
| <span className="ndl-data">Password</span> | {/*##input:password##*/}This input should contain the password for the new user.{/*##input##*/} |
| <span className="ndl-data">Email</span> | {/*##input:email##*/}Optionally the new user can be given assigned an email.{/*##input##*/} |
| <span className="ndl-data">Your custom properties</span> | {/*##input:prop-\*##*/}A property of the **User** class. You can add additional properties to the **User** class in the Noodl Cloud Services dashboard. {/*##input##*/} These will show up as inputs on the **Sign Up** node to optionally bhe given a value during sign up. |
| Signal | Description |
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal to this action to trigger the sign up. Once completed the **Success** or **Failure** event will be triggered.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal to this action to trigger the sign up. Once completed the **Success** or **Failure** event will be triggered.{/*##input##*/} |
## Outputs
| Signal | Description |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>This action will be triggered if the sign up was succesful. The user is now logged in and information about the user can be accessed via the **User** node.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>This action will be triggered if something went wrong while trying to sign up the user. The error message can be found in the **Error** output.<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This action will be triggered if the sign up was succesful. The user is now logged in and information about the user can be accessed via the **User** node.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This action will be triggered if something went wrong while trying to sign up the user. The error message can be found in the **Error** output.{/*##output##*/} |
| Data | Description |
| --------------------------------------- | ----------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Error</span> | <##output:error##>This output will contain the error message if the sign up failed.<##output##> |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}This output will contain the error message if the sign up failed.{/*##output##*/} |

32
nodes/data/user/user-node/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: User node
---
<##head##>
{/*##head##*/}
# User
@@ -24,31 +24,31 @@ The <span className="ndl-node">User</span> node only works if the user is create
</div>
<##head##>
{/*##head##*/}
## Inputs
| Signal | Description |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Fetch</span> | <##input:fetch##>Send a signal to this input to fetch the user properties for the current logged in user from the Noodl Cloud Services. There must be a valid user session for this to work.<##input##> |
| <span className="ndl-signal">Fetch</span> | {/*##input:fetch##*/}Send a signal to this input to fetch the user properties for the current logged in user from the Noodl Cloud Services. There must be a valid user session for this to work.{/*##input##*/} |
## Outputs
| Data | Description |
| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Id</span> | <##output:id##>The **Id** of the User record for the current logged in user.<##output##> |
| <span className="ndl-data">Username</span> | <##output:username##>The **Username** of the current logged in user.<##output##> |
| <span className="ndl-data">Email</span> | <##output:email##>The **Email** of the current logged in user, if the user has an email stored.<##output##> |
| <span className="ndl-data">Authenticated</span> | <##output:authenticated##>This output will be true if a valid user session exists in the browser, i.e. there is a logged in user.<##output##> |
| <span className="ndl-data">Error</span> | <##output:error##>If a **Fetch** action failed to retrieve the user information from the Noodl Cloud Services this output will contain the error message.<##output##> |
| <span className="ndl-data">Your custom properties</span> | <##output:prop-\*##>The value of extra properties of the **User** class specified in the Noodl Cloud Services.<##output##> The node will contain the latest value of all user properties. |
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The **Id** of the User record for the current logged in user.{/*##output##*/} |
| <span className="ndl-data">Username</span> | {/*##output:username##*/}The **Username** of the current logged in user.{/*##output##*/} |
| <span className="ndl-data">Email</span> | {/*##output:email##*/}The **Email** of the current logged in user, if the user has an email stored.{/*##output##*/} |
| <span className="ndl-data">Authenticated</span> | {/*##output:authenticated##*/}This output will be true if a valid user session exists in the browser, i.e. there is a logged in user.{/*##output##*/} |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}If a **Fetch** action failed to retrieve the user information from the Noodl Cloud Services this output will contain the error message.{/*##output##*/} |
| <span className="ndl-data">Your custom properties</span> | {/*##output:prop-\*##*/}The value of extra properties of the **User** class specified in the Noodl Cloud Services.{/*##output##*/} The node will contain the latest value of all user properties. |
| Signal | Description |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Fetched</span> | <##output:fetched##>This signal is triggered after a **Fetch** has been successfully performed. That is the **Fetch** action is triggered by a signal and the user data is return from the Noodl Cloud Services.<##output##> |
| <span className="ndl-signal">Changed</span> | <##output:changed##>This signal is triggered when the User is changed locally by a **Set User Properties** node or a **Fetch** action of a **User** node.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>This signal is triggered when a **Fetch** action failed to retrieve the latest user data from the Noodl Cloud Services. This could be due to an invalid session.<##output##> |
| <span className="ndl-signal">Logged In</span> | <##output:logged in##>This signal is triggered when a user has been successfully logged in.<##output##> |
| <span className="ndl-signal">Logged Out</span> | <##output:logged out##>This signal is triggered when a user has been successfully logged out.<##output##> |
| <span className="ndl-signal">Session Lost</span> | <##output:session lost##>This signal is triggered when the current user session becomes invalid, e.g. if it has timed out.<##output##> |
| <span className="ndl-signal">Changed events</span> | <##output:changed-\*##>This signal will be triggered when the property is changed using the **Set User Property** node or when the latest user data is retrieved from the Noodl Cloud Services with the **Fetch** action.<##output##> |
| <span className="ndl-signal">Fetched</span> | {/*##output:fetched##*/}This signal is triggered after a **Fetch** has been successfully performed. That is the **Fetch** action is triggered by a signal and the user data is return from the Noodl Cloud Services.{/*##output##*/} |
| <span className="ndl-signal">Changed</span> | {/*##output:changed##*/}This signal is triggered when the User is changed locally by a **Set User Properties** node or a **Fetch** action of a **User** node.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This signal is triggered when a **Fetch** action failed to retrieve the latest user data from the Noodl Cloud Services. This could be due to an invalid session.{/*##output##*/} |
| <span className="ndl-signal">Logged In</span> | {/*##output:logged in##*/}This signal is triggered when a user has been successfully logged in.{/*##output##*/} |
| <span className="ndl-signal">Logged Out</span> | {/*##output:logged out##*/}This signal is triggered when a user has been successfully logged out.{/*##output##*/} |
| <span className="ndl-signal">Session Lost</span> | {/*##output:session lost##*/}This signal is triggered when the current user session becomes invalid, e.g. if it has timed out.{/*##output##*/} |
| <span className="ndl-signal">Changed events</span> | {/*##output:changed-\*##*/}This signal will be triggered when the property is changed using the **Set User Property** node or when the latest user data is retrieved from the Noodl Cloud Services with the **Fetch** action.{/*##output##*/} |