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: fix broken links in faq.md #10744

Merged
merged 2 commits into from Oct 3, 2022
Merged

docs: fix broken links in faq.md #10744

merged 2 commits into from Oct 3, 2022

Conversation

bukowa
Copy link
Contributor

@bukowa bukowa commented Sep 29, 2022

No description provided.

@bukowa
fix broken links in faq.md
da9ae56 
Signed-off-by: Bukowa <gitbukowa@gmail.com>
@codecov
Copy link

codecov bot commented Sep 29, 2022 •
edited

Codecov Report

Base: 45.68% // Head: 45.65% // Decreases project coverage by -0.02% ⚠️

Coverage data is based on head (e7370e3) compared to base (1944141).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master   #10744      +/-   ##
==========================================
- Coverage   45.68%   45.65%   -0.03%     
==========================================
  Files         236      236              
  Lines       28668    28702      +34     
==========================================
+ Hits        13097    13104       +7     
- Misses      13779    13804      +25     
- Partials     1792     1794       +2
Impacted Files Coverage Δ
util/argo/argo.go 63.45% <0.00%> (-0.99%) ⬇️
cmd/argocd/commands/app.go 18.70% <0.00%> (-0.32%) ⬇️
util/dex/dex.go 58.62% <0.00%> (+1.47%) ⬆️
cmd/util/applicationset.go 19.23% <0.00%> (+19.23%) ⬆️

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.

@bukowa bukowa marked this pull request as ready for review September 29, 2022 17:21
crenshaw-dev
crenshaw-dev requested changes Sep 30, 2022
View reviewed changes
Copy link
Collaborator

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

@bukowa I'm not certain that these links are actually broken. Can you test here? https://argo-cd.readthedocs.io/en/latest/faq/

@bukowa
Copy link
Contributor Author

bukowa commented Oct 1, 2022

@bukowa I'm not certain that these links are actually broken. Can you test here? https://argo-cd.readthedocs.io/en/latest/faq/

But they are broken here https://github.com/argoproj/argo-cd/blob/master/docs/faq.md
And the docs are broken here https://argo-cd.readthedocs.io/en/stable/faq/ - that's strange

crenshaw-dev
crenshaw-dev requested changes Oct 1, 2022
View reviewed changes
docs/faq.md Outdated
@@ -201,7 +201,7 @@ argocd ... --insecure
## I have configured Dex via `dex.config` in `argocd-cm`, it still says Dex is unconfigured. Why?

Most likely you forgot to set the `url` in `argocd-cm` to point to your ArgoCD as well. See also
[the docs](/operator-manual/user-management/#2-configure-argo-cd-for-sso).
[the docs](./operator-manual/user-management/#2-configure-argo-cd-for-sso).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Looks like this is still broken in the test build. I think this would work:

Suggested change
[the docs](./operator-manual/user-management/#2-configure-argo-cd-for-sso).
[the docs](./operator-manual/user-management/index.md#2-configure-argo-cd-for-sso).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just pushed requested change, i wonder is there any application that could help prevent any documentation error like parsing links on repository and test build?

@crenshaw-dev crenshaw-dev changed the title fix broken links in faq.md docs: fix broken links in faq.md Oct 1, 2022
@crenshaw-dev crenshaw-dev added the cherry-pick/2.4 Candidate for cherry picking into the 2.4 release branch label Oct 1, 2022
@bukowa
doc:faq.md: fix
e7370e3 
Signed-off-by: bukowa <gitbukowa@gmail.com>
crenshaw-dev
crenshaw-dev approved these changes Oct 3, 2022
View reviewed changes
Copy link
Collaborator

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

Looks good in both GitHub and RTD. Thanks @bukowa!

@crenshaw-dev crenshaw-dev merged commit 5b13997 into argoproj:master Oct 3, 2022
crenshaw-dev pushed a commit that referenced this pull request Oct 3, 2022
@bukowa @crenshaw-dev
docs: fix broken links in faq.md (#10744)
c271f1a 
* fix broken links in faq.md

Signed-off-by: Bukowa <gitbukowa@gmail.com>

* doc:faq.md: fix

Signed-off-by: bukowa <gitbukowa@gmail.com>

Signed-off-by: Bukowa <gitbukowa@gmail.com>
Signed-off-by: bukowa <gitbukowa@gmail.com>
@crenshaw-dev
Copy link
Collaborator

Cherry-picked onto release-2.4 for 2.4.13.

ashutosh16 pushed a commit to ashutosh16/argo-cd that referenced this pull request Oct 7, 2022
@bukowa @ashutosh16
docs: fix broken links in faq.md (argoproj#10744)
18f114a 
* fix broken links in faq.md

Signed-off-by: Bukowa <gitbukowa@gmail.com>

* doc:faq.md: fix

Signed-off-by: bukowa <gitbukowa@gmail.com>

Signed-off-by: Bukowa <gitbukowa@gmail.com>
Signed-off-by: bukowa <gitbukowa@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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

Assignees
No one assigned
Labels
cherry-pick/2.4 Candidate for cherry picking into the 2.4 release branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@bukowa @crenshaw-dev