Skip to content

Commit

Permalink
edit docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
RayNawfal committed Mar 13, 2024
1 parent 1d5bcde commit 43214d2
Show file tree
Hide file tree
Showing 36 changed files with 48 additions and 48 deletions.
2 changes: 1 addition & 1 deletion javascript/json-url-stdout/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The Sequence takes three arguments:

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Sequence is ready to use, id doesn't use any external modules so no dependencies need to be installed.

Expand Down
2 changes: 1 addition & 1 deletion javascript/pokemon/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In this sample we use open API from <https://pokeapi.co>. Pokemon name will be p

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open two terminals and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion javascript/simple-counter-js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ As a default, the counter is started with 0 and ends with 1000. These values can

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open the terminal and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion javascript/test-output/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ___

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open the terminal and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion python/audio2text/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ For this Sequence to run properly, it is required to register and acquire an API

## Install and Run
---
Install the <a href="https://docs.scramjet.org/platform/self-hosted-installation/" target="_blank">Transform-Hub</a> locally or use
Install the <a href="https://docs.scramjet.org/transform-hub/installation" target="_blank">Transform-Hub</a> locally or use
<a href="https://docs.scramjet.org/platform/get-started/" target="_blank">Scramjet's Cloud Platform</a> environment for the Sequence deployment.
For more information on the below commands check the
<a href="https://docs.scramjet.org/platform/cli-reference/#useful-commands" target="_blank">CLI reference</a> section on Scramjet's Website.
Expand Down
2 changes: 1 addition & 1 deletion python/co2-emission/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Prepare configuration:
cp config-example.json config.json
```

and replace ```<YOUR-TOKEN>``` in ```config.json``` with token recevied from CO2Signal.
and replace ```<YOUR-TOKEN>``` in ```config.json``` with token received from CO2Signal.

## Running

Expand Down
2 changes: 1 addition & 1 deletion python/gh-issues-to-clickup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ___
- [Set config.json file](#set-configjson-file)
- [Send Sequence to Scramjet Cloud Platform](#send-sequence-to-scramjet-cloud-platform)

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
## Github

Expand Down
2 changes: 1 addition & 1 deletion python/hello-world-py/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Simple Sequence that outputs "Hello world" written in python

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open two terminals and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion python/kafka-consumer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ If you are looking for more advanced demo of usage, please check [README](../../

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
First, build kafka-consumer sample

Expand Down
2 changes: 1 addition & 1 deletion python/kafka-transformer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ If you are looking for more advanced demo of usage, please check [README](../../

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open two terminals and run the following commands:

Expand Down
4 changes: 2 additions & 2 deletions python/markdown-keywords/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

___

Easy example of usage Kaffka with Scramjet platform.
Easy example of usage Kafka with Scramjet platform.

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/get-started/) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open two terminals and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion python/overpass-api-fetch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ___
## Running
> 💡**NOTE:** Packaging of Python Sequences is not very "pythonic" for now. If you have any idea, how we should resolve it for your comfort, please let us know [here](https://github.com/scramjetorg/transform-hub/issues/598).
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open the terminal and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion python/rpilocator-scraper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ ___
## Running
> 💡**NOTE:** Packaging of Python Sequences is not very "pythonic" for now. If you have any idea, how we should resolve it for your comfort, please let us know [here](https://github.com/scramjetorg/transform-hub/issues/598).
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open the terminal and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion python/seq-fire-alert/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ ___

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open two terminals and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion python/telegram-read/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ At last, our bot must be added to the desired channel. In the Telegram client:
## Running
> 💡**NOTE:** Packaging of Python Sequences is not very "pythonic" for now. If you have any idea, how we should resolve it for your comfort, please let us know [here](https://github.com/scramjetorg/transform-hub/issues/598).
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open the terminal and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion python/telegram-write/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ At last, our bot must be added to the desired channel. In the Telegram client:
## Running
> 💡**NOTE:** Packaging of Python Sequences is not very "pythonic" for now. If you have any idea, how we should resolve it for your comfort, please let us know [here](https://github.com/scramjetorg/transform-hub/issues/598).
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open the terminal and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion python/voice-recognition/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ sudo apt-get install python3-pyaudio
## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open the terminal and run the following commands:

Expand Down
12 changes: 6 additions & 6 deletions typescript/audio2text-event/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Audio2text Events

This is best version of Audio2Text which uses input channel aswell as Events and allows sending more then 1 file
This is best version of Audio2Text which uses input channel as well as Events and allows sending more then 1 file

The audio file
<a href="https://salford.figshare.com/collections/HARVARD_speech_corpus_-_audio_recording_2019/4437578" target="_blank">`song.wav`</a> is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License.
Expand All @@ -9,13 +9,13 @@ ___

## Description

This is a sequence which transript audio file using AssemblyAi API.
This is a sequence which transcript audio file using AssemblyAi API.

## Prerequisites

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
As this apps is using AssemblyAi Api, the key is required to use it. For informations how to get one please refer to [assemblyAi](https://www.assemblyai.com/)
As this apps is using AssemblyAi Api, the key is required to use it. For information how to get one please refer to [assemblyAi](https://www.assemblyai.com/)

## Running

Expand All @@ -31,7 +31,7 @@ npm install
# transpile TS->JS to dist/
npm run build

# deploy the Sequence withh a following arguments where first one is a time interval in ms which determines how often to check for data and second is github api key
# deploy the Sequence with a following arguments where first one is a time interval in ms which determines how often to check for data and second is github api key
si seq deploy dist --args '["YOUR-GITHUB-API-KEY-HERE"]'

# upload file to a instance
Expand All @@ -41,7 +41,7 @@ si inst input - /path/to/your/file -t application/octet-stream

## Getting results

All the informations generated by this instance will be available at the log channel.
All the information generated by this instance will be available at the log channel.

To get result simply type in console:

Expand Down
6 changes: 3 additions & 3 deletions typescript/audio2text-input/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ This is a sequence which transript audio file using AssemblyAi API.

## Prerequisites

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
As this apps is using AssemblyAi Api, the key is required to use it. For informations how to get one please refer to [assemblyAi](https://www.assemblyai.com/)
As this apps is using AssemblyAi Api, the key is required to use it. For information how to get one please refer to [assemblyAi](https://www.assemblyai.com/)

## Running

Expand Down Expand Up @@ -47,7 +47,7 @@ si inst input - /path/to/your/file -e -t application/octet-stream

## Getting results

All the informations generated by this instance will be available at the log channel.
All the information generated by this instance will be available at the log channel.

To get result simply type in console:

Expand Down
4 changes: 2 additions & 2 deletions typescript/clockify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You need to have a [clockify account](https://app.clockify.me/signup) and a [acc
You also need to have scramjet cli installed, for guide how to install [visit our documentation](https://docs.scramjet.org/platform/get-started/)
## Preparations

Before running the code enter valid data in `data.json`, you need to fill all options to make the code working. For more informations how to get those details visit [Clockify Api documentation](https://docs.clockify.me/).
Before running the code enter valid data in `data.json`, you need to fill all options to make the code working. For more information how to get those details visit [Clockify Api documentation](https://docs.clockify.me/).

```json
{
Expand Down Expand Up @@ -51,4 +51,4 @@ si sequence deploy dist --args [1,\"key\"]

```

After completeing all steps the instance should be running and adding new entries to clockify daily.
After completing all steps the instance should be running and adding new entries to clockify daily.
2 changes: 1 addition & 1 deletion typescript/crypto-prices/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ ___
## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open the terminal and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion typescript/discord-read/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Move the `config.json` file to `discord-read` sample directory.

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.

```bash
Expand Down
2 changes: 1 addition & 1 deletion typescript/discord-write/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Before start you need `DISCORD_WEBHOOK_URL`. In Discord go to your server. Then

WebHook URL has following format: `https://discord.com/api/webhooks/{webhook.id}/{webhook.token}` where `webhook.id` are numbers and `webhook.token` are letters and numbers.

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open the terminal and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion typescript/hello-world-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Simple sequence that outputs "Hello world" written in typescript.

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open two terminals and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion typescript/hexdump/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ___

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open two terminals and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion typescript/linkedin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Create `config.json` file with following content:

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open two terminals and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion typescript/mediawiki/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ___

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open the terminal and run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion typescript/read-targz-stats/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ___

## Running

> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/platform/self-hosted-installation) or use the [platform's environment](https://docs.scramjet.org/platform/quick-start) for the sequence deployment.
> ❗ Remember to [setup transform-hub locally](https://docs.scramjet.org/transform-hub/installation) or use the [platform's environment](https://docs.scramjet.org/platform/get-started/) for the sequence deployment.
Open two terminals and run the following commands:

Expand Down
Loading

0 comments on commit 43214d2

Please sign in to comment.