Skip to content

Commit

Permalink
Update documentation on quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanjjung committed Jan 29, 2025
1 parent 271ac14 commit ae87d57
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
15 changes: 8 additions & 7 deletions docs/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ refer to your particular project details:

.. code-block:: bash
./quickstart.sh \
/path/to/project/root # The root of your code project where you want to set up a pulumi project
pulumi-state-s3-bucket-name \ # S3 bucket where you'll store your pulumi state files
project_name, \ # Name of your project as it will be known to pulumi
stack_name, \ # Name of the first stack you want to create
[code_version] # Code version (git branch) that you want to pin. Optional; defaults to "main"
./quickstart.sh \
/path/to/project/root \ # The root of your code project where you want to set up a pulumi project
pulumi_login_url \ # URL to use with `pulumi login`; use "https://api.pulumi.com" for Pulumi Cloud
project_name, \ # Name of your project as it will be known to pulumi
stack_name, \ # Name of the first stack you want to create
[code_version] # Code version (git branch) that you want to pin. Optional; defaults to "main"
This will...

Expand Down Expand Up @@ -77,7 +77,8 @@ Manual Setup
S3 bucket
^^^^^^^^^

.. note:: This step is optional. If you do not set up an S3 bucket, you can use Pulumi Cloud instead.
.. note:: This step is optional. If you do not set up an S3 bucket, you can use Pulumi Cloud instead by specifying
``https://api.pulumi.com`` as the ``pulumi-login-url``.

Create an S3 bucket in which to store state for the project. You must have one bucket devoted to your project, but you
can store multiple stacks' state files in that one bucket. The bucket should not be public (treat these files as
Expand Down
2 changes: 1 addition & 1 deletion quickstart.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#
# ./quickstart.sh \
# /path/to/project/root \ # The root of your code project where you want to set up a pulumi project
# pulumi-login-url \ # URL to use with `pulumi login`; use "https://api.pulumi.com" for Pulumi Cloud
# pulumi_login_url \ # URL to use with `pulumi login`; use "https://api.pulumi.com" for Pulumi Cloud
# project_name, \ # Name of your project as it will be known to pulumi
# stack_name, \ # Name of the first stack you want to create
# [code_version] # Code version (git branch) that you want to pin. Optional; defaults to "main"
Expand Down

0 comments on commit ae87d57

Please sign in to comment.