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: Fix links on architecture.md #1316

Closed

Conversation

shuheiktgw
Copy link
Contributor

@shuheiktgw shuheiktgw commented Jun 29, 2021

It seems the links on the architecture page are broken and point to the wrong places so I fixed it.

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this is a chore.
  • The title of the PR is (a) conventional, (b) states what changed, and (c) suffixes the related issues number. E.g. "fix(controller): Updates such and such. Fixes #1234".
  • I've signed my commits with DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My builds are green. Try syncing with master if they are not.
  • My organization is added to USERS.md.

@sonarcloud
Copy link

sonarcloud bot commented Jun 29, 2021

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
5.0% 5.0% Duplication

@codecov
Copy link

codecov bot commented Jun 29, 2021

Codecov Report

Merging #1316 (dd7def2) into master (255ce28) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1316   +/-   ##
=======================================
  Coverage   81.39%   81.39%           
=======================================
  Files         106      106           
  Lines        9723     9723           
=======================================
  Hits         7914     7914           
  Misses       1271     1271           
  Partials      538      538           

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 255ce28...dd7def2. Read the comment docs.

@kostis-codefresh
Copy link
Member

I think this is related to #1278

Something seems to have changed the way docs are rendered (with or without .html at the end)

@shuheiktgw
Copy link
Contributor Author

Yes, I think something seems to be wrong with the links on the documentation yet the links on the architecture page points to the wrong places so that's one problem.

@jessesuen
Copy link
Member

I fixed the source of the problem so this PR is unnecessary. See: https://argoproj.github.io/argo-rollouts/architecture/

Our site generation was recently affected by a change config requirements mkdocs.yaml and we use :latest mkdocs image to generate the docs. I fixed our config to adhere to new mkdocs.yaml config requirements

@jessesuen jessesuen closed this Jul 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants