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

Docs: Getting Started Page containing broken link, 404 pages not formatting correctly, and missing step for creating apps via CLI #10376

Closed
kmlamkin9 opened this issue Aug 17, 2022 · 0 comments · Fixed by #10623
Labels
enhancement New feature or request good first issue Good for newcomers GraceHopperOSD2022 Good for 2022 Grace Hopper Celebration Open Source Day type:docs Missing or incomplete documentation

Comments

@kmlamkin9
Copy link
Contributor

Summary

Docs: Getting Started Page containing broken link, 404 pages not formatting correctly, and missing step for creating apps via CLI

Use Cases

  1. On the getting started page under step 1, there is the text "Follow the instructions to configure a certificate (and ensure that the client OS trusts it)." In this text, that hyper link points to a 404 page. This text should either be removed from the getting started guide if it's not needed anymore, or the link should be updated to point to the proper doc.
  2. The 404 pages are also not formatted correctly and are unreadable.
  3. On the getting started page under step 6 create apps via CLI, we should add the command for setting default namespace kubectl config set-context --current --namespace=argocd. The command won't work unless the context points to the argocd namespace. There was a stackoverflow post about it viewed > 2k times. Since it looks like many encounter this issue, we should add a small snippet with this command to reduce # of searches users have to do to spin up ArgoCD.

Message from the maintainers:

Impacted by this bug? Give it a 👍. We prioritize the issues with the most 👍.

@kmlamkin9 kmlamkin9 added the enhancement New feature or request label Aug 17, 2022
@crenshaw-dev crenshaw-dev added good first issue Good for newcomers GraceHopperOSD2022 Good for 2022 Grace Hopper Celebration Open Source Day type:docs Missing or incomplete documentation labels Sep 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers GraceHopperOSD2022 Good for 2022 Grace Hopper Celebration Open Source Day type:docs Missing or incomplete documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants