Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation on quickstart #93

Merged
merged 1 commit into from
Jan 29, 2025
Merged

Update documentation on quickstart #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions docs/getting-started.rst
View file
Open in desktop
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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possibly obvious, but: if the user does set up an S3 bucket, how do they specify it? It looks like that argument for the quickstart.sh is removed?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You would specify it as a full URL, like s3://name-of-your-bucket

``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
View file
Open in desktop
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