Skip to content

Commit

Permalink
Improve .post-create message (temporalio#107)
Browse files Browse the repository at this point in the history
* Improve .post-create message

* Add non-Mac links

* Add .post-create for monorepo

* Update excluded .post-creates
  • Loading branch information
lorensr authored Mar 17, 2022
1 parent aea8838 commit 75bdcd6
Show file tree
Hide file tree
Showing 28 changed files with 349 additions and 106 deletions.
16 changes: 12 additions & 4 deletions .shared/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
16 changes: 12 additions & 4 deletions activities-cancellation-heartbeating/.post-create
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, follow instructions in the {cyan README.md}
16 changes: 12 additions & 4 deletions activities-dependency-injection/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
16 changes: 12 additions & 4 deletions activities-examples/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
16 changes: 12 additions & 4 deletions activities-sticky-queues/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
16 changes: 12 additions & 4 deletions child-workflows/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
16 changes: 12 additions & 4 deletions continue-as-new/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
16 changes: 12 additions & 4 deletions cron-workflows/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
16 changes: 12 additions & 4 deletions dsl-interpreter/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
16 changes: 12 additions & 4 deletions expense/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
16 changes: 12 additions & 4 deletions fetch-esm/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
16 changes: 12 additions & 4 deletions grpc-calls/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
16 changes: 12 additions & 4 deletions hello-world-js/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
20 changes: 18 additions & 2 deletions hello-world-mtls/.post-create
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
To begin development, follow the mTLS setup instructions:
To begin development, install Docker:

{bold https://docs.temporal.io/docs/typescript/security/#mtls-tutorial}
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then follow the mTLS setup instructions:

{bold https://docs.temporal.io/docs/typescript/security/#mtls-tutorial}

For step 8, run:

Expand Down
16 changes: 12 additions & 4 deletions hello-world/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
16 changes: 12 additions & 4 deletions instrumentation/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
16 changes: 12 additions & 4 deletions interceptors-opentelemetry/.post-create
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
To begin development, start Temporal Server:
To begin development, install Docker:

{cyan cd} ~/path/to/temporal/docker-compose/
Mac: {cyan brew cask install docker; open} /Applications/Docker.app
Other: https://www.docker.com/products/docker-desktop

Start Temporal Server:

{cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
{cyan cd} temporal-server/
{cyan docker-compose up}

{dim.italic If you haven’t run Temporal Server before, visit:
https://docs.temporal.io/docs/typescript/getting-started/}
Use Node version 14+:

Mac: {cyan brew install node@16}
Other: https://nodejs.org/en/download/

Then, in the project directory, using two other shells, run these commands:

Expand Down
Loading

0 comments on commit 75bdcd6

Please sign in to comment.