Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.

Add explanatory text to Getting Started section #5

Merged
merged 2 commits into from
Aug 8, 2023

Conversation

tserong
Copy link
Member

@tserong tserong commented Aug 2, 2023

This provides a bit more detail about exactly what you're getting yourself into with each of the example deployment methods.

I've also added publicDomain settings to the helm install invocation, because those are the minimum things you actually need to set for the install to work.

Copy link
Member

@jecluis jecluis left a comment

Choose a reason for hiding this comment

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

The sslip.io bit should be dropped IMO.

src/pages/index.js Outdated Show resolved Hide resolved
If publicDomain and ui.publicDomain aren't specified somehow
(whether via `--set ...` or `-f values.yaml`), the installation
will fail with "Please provide a value for `.Values.publicDomain`"
and "Please provide a value for `.Values.ui.publicDomain`".  We
can at least hint at this need in advance by suggesting to use
YOUR_DOMAIN_NAME in both cases.

Signed-off-by: Tim Serong <[email protected]>
@tserong tserong force-pushed the wip-more-getting-started-deets branch from 70f1857 to a692a98 Compare August 2, 2023 12:09
@jecluis
Copy link
Member

jecluis commented Aug 2, 2023

@asettle mind taking a look, given this is going on the website you might have an opinion :)

Copy link
Contributor

@jhmarina jhmarina left a comment

Choose a reason for hiding this comment

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

lgtm!

This provides a bit more detail about exactly what you're getting
yourself into with each of the example deployment methods.

Signed-off-by: Tim Serong <[email protected]>
@tserong tserong force-pushed the wip-more-getting-started-deets branch from a692a98 to 1227530 Compare August 8, 2023 09:19
@tserong
Copy link
Member Author

tserong commented Aug 8, 2023

(Just removed double spaces after periods -- all else is the same)

Copy link
Contributor

@m-ildefons m-ildefons left a comment

Choose a reason for hiding this comment

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

LGTM

@jecluis jecluis merged commit eaf80c0 into aquarist-labs:main Aug 8, 2023
2 checks passed
@tserong tserong deleted the wip-more-getting-started-deets branch August 8, 2023 12:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants