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

Fixes #3424: broken link in the docs #3509

Merged
merged 5 commits into from Jul 6, 2023
Merged

Fixes #3424: broken link in the docs #3509

merged 5 commits into from Jul 6, 2023

Conversation

hornokattila
Copy link
Contributor

Context

Fixes #3424

In the current version of the documentation, the "Nginx + Image Archive" page has a dead link to "user account control recipe".
The root cause is that the "user-account-control.md" file was not carried over to the current version of the documentation.

Changes & Results

Changes:

  • Carrying over the above mentioned missing MD file to the current documentation
  • Fixing some of the links in it due to structural changes in the current version of the documentation

Results:

  • Links in the documentation are working as expected.

Testing

  • Navigate to the "Nginx + Image Archive" section of the documentation
  • Click on the "user account control recipe" link

Checklist

PR

  • My Pull Request title is descriptive, accurate and follows the
    semantic-release format and guidelines.

Code

  • My code has been well-documented (function documentation, inline comments,
    etc.)

Public Documentation Updates

  • The documentation page has been updated as necessary for any public API
    additions or removals.

Tested Environment

  • OS:
  • Node version:
  • Browser:
    • Safari 16.5.1

@netlify
Copy link

netlify bot commented Jun 29, 2023

Deploy Preview for ohif-platform-docs ready!

Name Link
🔨 Latest commit ef037dc
🔍 Latest deploy log https://app.netlify.com/sites/ohif-platform-docs/deploys/64a47903578fdf0008b6a43b
😎 Deploy Preview https://deploy-preview-3509--ohif-platform-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@netlify
Copy link

netlify bot commented Jun 29, 2023

Deploy Preview for ohif-dev ready!

Name Link
🔨 Latest commit ef037dc
🔍 Latest deploy log https://app.netlify.com/sites/ohif-dev/deploys/64a4790327a0420008311047
😎 Deploy Preview https://deploy-preview-3509--ohif-dev.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov
Copy link

codecov bot commented Jun 29, 2023

Codecov Report

Merging #3509 (ef037dc) into master (ed44ad7) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3509   +/-   ##
=======================================
  Coverage   42.81%   42.81%           
=======================================
  Files          82       82           
  Lines        1448     1448           
  Branches      338      338           
=======================================
  Hits          620      620           
  Misses        665      665           
  Partials      163      163           

Continue to review full report in Codecov by Sentry.

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

@sedghi
Copy link
Member

sedghi commented Jul 3, 2023

Thanks a lot! Question, have you tried the keyclock doc in v3 and it works? (didn't have time to try it yet)

@hornokattila
Copy link
Contributor Author

Had to fix a few links, like the assets/img folder is in a different location in v3.
But yeah, it should work.

@sedghi
Copy link
Member

sedghi commented Jul 4, 2023

Maybe I was not clear, did you followed the doc and were able to successfully add the keyclock to OHIF?

@hornokattila
Copy link
Contributor Author

Ohh!
My bad.
Sorry for the misunderstanding.

No, I have not had the chance to set up KeyCloak yet.
I just fixed the documentation.

@sedghi
Copy link
Member

sedghi commented Jul 4, 2023

I was afraid so too, so in case you did not try it, I rather remove the doc since I don't want to add a doc that doesn't work. Can your PR only include the fix for the broken link?

@hornokattila
Copy link
Contributor Author

This is fixing the broken link.
I only moved over the user-account-control docs to v3 so the corresponding link would start working on the nginx--image-archive page.
If we would rather get rid of this doc, I recommend removing the whole paragraph that mentions it in nginx--image-archive.
Shall we go that way?

@sedghi
Copy link
Member

sedghi commented Jul 4, 2023

sure, let's remove that and the keyclock dock for now

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.

[Bug] broken link in the docs
2 participants