-
Notifications
You must be signed in to change notification settings - Fork 3.1k
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: modify to detailed links + add details to running-locally #11405
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Joibel Could you help review this?
@terrytangyuan Thanks for your help. I was confused because all the spelling errors in the checks from the original |
Signed-off-by: Dahye Ahn <andyourturntome@gmail.com>
Signed-off-by: Dahye Ahn <andyourturntome@gmail.com>
fix typo Signed-off-by: Dahye Ahn <andyourturntome@gmail.com>
d0e6cb9
to
39a157d
Compare
Good change! I think I stumbled upon this myself and just forgot about it as I don't use the CLI
Hmm so it might make sense to just link downward to "Developing Locally" using its anchor
Not sure why these just started showing up now 🤔 Seems to be erroring on code backticks. EDIT: see below comment, I figured that out |
docs/running-locally.md
Outdated
If you want to see Argo Workflows UI in http://localhost:8080: | ||
``` | ||
make start UI=true | ||
```` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure why these just started showing up now 🤔 Seems to be erroring on code backticks.
there's 4 backticks on this line instead of 3 -- that's what's causing make docs-spellcheck
to fail. it's just causing syntax errors in general.
you'll then also need to change "popup" to "pop-up" to fix the spelling.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for letting me know!!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed this draft pr to open. Please review when you have the time.
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Signed-off-by: Dahye <61692777+da-head0@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One small change requested, otherwise LGTM! 😃
Signed-off-by: Dahye Ahn <andyourturntome@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks for working through the dev process and improving it!
Fixes #TODO
Motivation
When I first tried to install Argo Workflows using Dev Containers in my local environment, I was confused because the link to the The Visual Studio Code Remote - Containers and Dev-container CLI in the documentation didn't go to the link to extension or Dev-Container CLI itself, even though the context indicates that this is a link for that.
Also, as someone new to Dev Containers, I didn't know that I needed to use the
make clean
&make start
to boilerplate, so I had to infer from the #Developing Locally section in the middle of the documentation how to get Argo Workflows running in my local environment.The changes I've made to the documentation are located earlier in the documentation and would make getting up and running with Argo Workflows faster and easier for someone like me who is new to Argo Workflows or Dev Containers.
Modifications
Verification