Skip to content

docs: clarify command for new repo, port-forward flags #6937

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

Jump to bottom
Merged
merged 1 commit into from
Aug 25, 2021
Merged

docs: clarify command for new repo, port-forward flags #6937

merged 1 commit into from
Aug 25, 2021

Conversation

joshgav
Copy link
Contributor

@joshgav joshgav commented Aug 9, 2021 •
edited
Loading

The instructions for telling the CLI how to automatically use port-forward were intertwined with the instructions for registering a repo; this separates them.

This also moves the port-forward flags instructions to the first place in the doc a user would need them.

Note on DCO:

If the DCO action in the integration test fails, one or more of your commits are not signed off. Please click on the Details link next to the DCO action for instructions on how to resolve this.

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • Optional. My organization is added to USERS.md.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).

jannfis
jannfis requested changes Aug 17, 2021
View reviewed changes
Copy link
Member

@jannfis jannfis left a comment

Choose a reason for hiding this comment

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

Thanks for improving the docs, @joshgav.

I have a minor request for change, please see below.

@joshgav joshgav force-pushed the patch-1 branch 2 times, most recently from 725b5f3 to d7becbb Compare August 23, 2021 13:32
@joshgav
docs: clarify new repo, port-forward flags
a1ea055 
The instructions for telling the CLI how to automatically use
port-forward were intertwined with the instructions for registering a
repo; this separates them.

This also moves the port-forward flags instructions to the first place
in the doc a user would need them.

Signed-off-by: Josh Gavant <joshgavant@gmail.com>
@joshgav joshgav requested a review from jannfis August 23, 2021 18:10
@codecov
Copy link

codecov bot commented Aug 25, 2021 •
edited
Loading

Codecov Report

Merging #6937 (a1ea055) into master (3091bc5) will decrease coverage by 0.07%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6937      +/-   ##
==========================================
- Coverage   41.13%   41.06%   -0.08%     
==========================================
  Files         157      158       +1     
  Lines       20993    21305     +312     
==========================================
+ Hits         8636     8748     +112     
- Misses      11129    11304     +175     
- Partials     1228     1253      +25
Impacted Files Coverage Δ
server/project/project.go 52.89% <0.00%> (-2.57%) ⬇️
util/tls/tls.go 77.99% <0.00%> (-1.44%) ⬇️
util/argo/argo.go 63.79% <0.00%> (-1.10%) ⬇️
util/settings/settings.go 47.38% <0.00%> (-0.39%) ⬇️
server/server.go 53.61% <0.00%> (-0.29%) ⬇️
cmd/util/repo.go 0.00% <0.00%> (ø)
controller/metrics/clustercollector.go 0.00% <0.00%> (ø)
pkg/apis/application/v1alpha1/repository_types.go 60.52% <0.00%> (ø)
server/repository/repository.go 35.77% <0.00%> (ø)
util/db/repository_secrets.go 67.79% <0.00%> (+0.27%) ⬆️
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3091bc5...a1ea055. Read the comment docs.

@jannfis jannfis changed the title clarify command for new repo, port-forward flags docs: clarify command for new repo, port-forward flags Aug 25, 2021
jannfis
jannfis approved these changes Aug 25, 2021
View reviewed changes
Copy link
Member

@jannfis jannfis left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM

@jannfis jannfis merged commit 18057fa into argoproj:master Aug 25, 2021
plakyda-codefresh pushed a commit to plakyda-codefresh/argo-cd that referenced this pull request Sep 28, 2021
@joshgav @plakyda1
docs: clarify new repo, port-forward flags (argoproj#6937)
ab3c1d9 
The instructions for telling the CLI how to automatically use
port-forward were intertwined with the instructions for registering a
repo; this separates them.

This also moves the port-forward flags instructions to the first place
in the doc a user would need them.

Signed-off-by: Josh Gavant <joshgavant@gmail.com>
Signed-off-by: viktorplakida <plakyda1@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jannfis jannfis jannfis approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@joshgav @jannfis