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.

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

[Bug]: typo and missing option in installation instructions #1047

Closed
1 task done
lvaylet opened this issue Sep 6, 2023 · 0 comments · Fixed by #1060
Closed
1 task done

[Bug]: typo and missing option in installation instructions #1047

lvaylet opened this issue Sep 6, 2023 · 0 comments · Fixed by #1060
Assignees
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Milestone

Comments

@lvaylet
Copy link

lvaylet commented Sep 6, 2023

Version of Cloud Ops Sandbox

0.9.2

Your client machine OS?

Linux

Tell us, what is a problem?

The installation instructions in README.md and docs/README.md both contain a typo in the gcloud command that retrieves Application Default Credentials (ADC). In addition, docs/README.md has a missing option in the sandboxctl command responsible for creating the resources. As a result, users might not be able to provision the sandbox if they copy/paste the instructions.

What you expected to happen?

Installation instructions with no typos and no missing options, that can safely be copy/pasted.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@lvaylet lvaylet added triage me I really want to be triaged. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Sep 6, 2023
@arbrown arbrown added priority: p2 Moderately-important priority. Fix may not be included in next release. and removed triage me I really want to be triaged. labels Sep 7, 2023
@minherz minherz added this to the version 0.10 milestone Oct 24, 2023
minherz added a commit that referenced this issue Oct 24, 2023
)

Replace 'loging' with 'login' in tutorial and README instructions and adds "create" command in markdown. (#1047)
Fixes errors (#1045) and refactors use of kustomize path in CLI.
Makes GKE+ASM provisioning a module.
Makes Online Boutique provisioning a module.
Creates a new 'main.tf' TF configuration to provision modules sequentially, because of the hard dependency there is no effective way to paralelize it.
Refactors "online-boutique" to replace with "microservices-demo".
minherz added a commit that referenced this issue Nov 21, 2023
comment markdown to show status badges. fixes #1051
update the subcommand for gcloud auth. partially fixes #1047
minherz added a commit that referenced this issue Nov 21, 2023
update subcommand in gcloud auth. update sandboxctl command to create Sandbox.
partially fixes #1047.
minherz added a commit that referenced this issue Nov 25, 2023
)

Replace 'loging' with 'login' in tutorial and README instructions and adds "create" command in markdown. (#1047)
Fixes errors (#1045) and refactors use of kustomize path in CLI.
Makes GKE+ASM provisioning a module.
Makes Online Boutique provisioning a module.
Creates a new 'main.tf' TF configuration to provision modules sequentially, because of the hard dependency there is no effective way to paralelize it.
Refactors "online-boutique" to replace with "microservices-demo".
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
3 participants