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.

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

docs: added deep links doc #11888

Merged
merged 7 commits into from
Jan 10, 2023
Merged

docs: added deep links doc #11888

merged 7 commits into from
Jan 10, 2023

Conversation

gdsoumya
Copy link
Member

@gdsoumya gdsoumya commented Jan 5, 2023 •
edited
Loading

Signed-off-by: Soumya Ghosh Dastidar gdsoumya@gmail.com

This PR adds a doc section for setting up deep links

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).

@gdsoumya
docs: added deep links doc
38e38d7 
Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>
@codecov
Copy link

codecov bot commented Jan 5, 2023 •
edited
Loading

Codecov Report

Base: 47.30% // Head: 47.29% // Decreases project coverage by -0.00% ⚠️

Coverage data is based on head (27f491c) compared to base (052a5d2).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master   #11888      +/-   ##
==========================================
- Coverage   47.30%   47.29%   -0.01%     
==========================================
  Files         245      245              
  Lines       41661    41665       +4     
==========================================
  Hits        19706    19706              
- Misses      19970    19974       +4     
  Partials     1985     1985
Impacted Files Coverage Δ
controller/appcontroller.go 51.88% <0.00%> (-0.11%) ⬇️
server/application/terminal.go 20.64% <0.00%> (-0.10%) ⬇️
util/settings/settings.go 48.42% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

wojtekidd
wojtekidd suggested changes Jan 5, 2023
View reviewed changes
Copy link
Contributor

@wojtekidd wojtekidd left a comment

Choose a reason for hiding this comment

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

Check out my suggestions before merging please 👍🏻

docs/user-guide/deep_links.md Outdated Show resolved Hide resolved
docs/user-guide/deep_links.md Outdated Show resolved Hide resolved
docs/user-guide/deep_links.md Outdated Show resolved Hide resolved
docs/user-guide/deep_links.md Outdated Show resolved Hide resolved
docs/user-guide/deep_links.md Outdated Show resolved Hide resolved
docs/user-guide/deep_links.md Outdated Show resolved Hide resolved
docs/user-guide/deep_links.md Outdated Show resolved Hide resolved
docs/user-guide/deep_links.md Outdated Show resolved Hide resolved
docs/user-guide/deep_links.md Outdated Show resolved Hide resolved
@gdsoumya
refactor: resolved review comments
3c6a13e 
Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>
alexmt
alexmt requested changes Jan 5, 2023
View reviewed changes
Copy link
Collaborator

@alexmt alexmt left a comment

Choose a reason for hiding this comment

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

Thank you! Just couple comments about location of this document

docs/user-guide/deep_links.md Outdated Show resolved Hide resolved
docs/user-guide/deep_links.md Outdated Show resolved Hide resolved
@gdsoumya
refactor: moved cmp and deep links doc to operator manual
6817e88 
Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>
alexmt
alexmt approved these changes Jan 5, 2023
View reviewed changes
Copy link
Collaborator

@alexmt alexmt left a comment

Choose a reason for hiding this comment

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

LGTM

crenshaw-dev
crenshaw-dev requested changes Jan 9, 2023
View reviewed changes
Copy link
Member

@crenshaw-dev crenshaw-dev left a comment

Choose a reason for hiding this comment

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

Could you add a !!! warning block at the bottom reminding the operator that they should validate/sanitize input to prevent users from constructing malicious links?

docs/operator-manual/deep_links.md Show resolved Hide resolved
docs/operator-manual/deep_links.md Show resolved Hide resolved
rbreeze
rbreeze approved these changes Jan 9, 2023
View reviewed changes
Copy link
Member

@rbreeze rbreeze left a comment

Choose a reason for hiding this comment

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

LGTM

@gdsoumya
feat: add warning for templates
eaee364 
Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>
@gdsoumya
Merge branch 'docs/deep_link' of github.com:gdsoumya/argo-cd into doc…
fde9dd5 
…s/deep_link
@gdsoumya gdsoumya mentioned this pull request Jan 10, 2023
Merged
10 tasks
@gdsoumya
feat: add note for secret data fields being redacted
27f491c 
Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>
crenshaw-dev
crenshaw-dev approved these changes Jan 10, 2023
View reviewed changes
Copy link
Member

@crenshaw-dev crenshaw-dev left a comment

Choose a reason for hiding this comment

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

Awesome, thank you!

@crenshaw-dev crenshaw-dev merged commit 7f2dd9e into argoproj:master Jan 10, 2023
crenshaw-dev pushed a commit that referenced this pull request Jan 10, 2023
@gdsoumya @crenshaw-dev
docs: added deep links doc (#11888)
fe8049f 
* docs: added deep links doc

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

* refactor: resolved review comments

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

* refactor: moved cmp and deep links doc to operator manual

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

* feat: add warning for templates

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

* feat: add note for secret data fields being redacted

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>
@crenshaw-dev
Copy link
Member

Cherry-picked onto release-2.6.

@jannfis jannfis mentioned this pull request Jan 20, 2023
Merged
10 tasks
emirot pushed a commit to emirot/argo-cd that referenced this pull request Jan 27, 2023
@gdsoumya @emirot
docs: added deep links doc (argoproj#11888)
2891588 
* docs: added deep links doc

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

* refactor: resolved review comments

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

* refactor: moved cmp and deep links doc to operator manual

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

* feat: add warning for templates

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

* feat: add note for secret data fields being redacted

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>
Signed-off-by: emirot <emirot.nolan@gmail.com>
schakrad pushed a commit to schakrad/argo-cd that referenced this pull request Mar 14, 2023
@gdsoumya @schakrad
docs: added deep links doc (argoproj#11888)
dde5f32 
* docs: added deep links doc

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

* refactor: resolved review comments

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

* refactor: moved cmp and deep links doc to operator manual

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

* feat: add warning for templates

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

* feat: add note for secret data fields being redacted

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>

Signed-off-by: Soumya Ghosh Dastidar <gdsoumya@gmail.com>
Signed-off-by: schakrad <chakradari.sindhu@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jannfis jannfis jannfis left review comments

@alexmt alexmt alexmt approved these changes

@rbreeze rbreeze rbreeze approved these changes

@wojtekidd wojtekidd wojtekidd approved these changes

@crenshaw-dev crenshaw-dev crenshaw-dev approved these changes

@jessesuen jessesuen Awaiting requested review from jessesuen

Assignees
No one assigned
Labels
cherry-pick/2.6
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@gdsoumya @crenshaw-dev @alexmt @jannfis @wojtekidd @rbreeze