Skip to content

Remove broken deployment.md link in INSTALL.md #1243

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

yue-here
Copy link

deployment.md no longer exists, this removes the broken link in the first instance and changes the link to https://docs.datalab-org.io/en/stable/deployment/ in the second

deployment.md no longer exists, this removes the broken link in the first instance and changes the link to https://docs.datalab-org.io/en/stable/deployment/ in the second
Copy link

codecov bot commented Jun 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.73%. Comparing base (66be21f) to head (0092fb1).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1243   +/-   ##
=======================================
  Coverage   71.73%   71.73%           
=======================================
  Files          66       66           
  Lines        4482     4482           
=======================================
  Hits         3215     3215           
  Misses       1267     1267           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link

cypress bot commented Jun 20, 2025

datalab    Run #3481

Run Properties:  status check passed Passed #3481  •  git commit 5791225099 ℹ️: Merge 0092fb1f4e0bef42147707511244c4a97c683fd6 into 66be21f5343304ebf7a9c1486583...
Project datalab
Branch Review update-install-md
Run status status check passed Passed #3481
Run duration 08m 27s
Commit git commit 5791225099 ℹ️: Merge 0092fb1f4e0bef42147707511244c4a97c683fd6 into 66be21f5343304ebf7a9c1486583...
Committer Yue Wu
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 504
View all changes introduced in this branch ↗︎

A further reading of the docs shows that the authentication info is not in "deployment" but "configuration", link has been changed to reflect this.
Copy link
Member

@ml-evs ml-evs left a comment

Choose a reason for hiding this comment

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

This "internal" link actually works fine when rendered by the docs (https://docs.datalab-org.io/en/latest/INSTALL) -- I think I'm of the opinion that we should actually just move this file into the docs directly and link to it from the README, rather than maintaining it as a symlink. There's also lots of formatting that doesn't render properly on GitHub as its targeted at mkdocs, e.g., the tabbed uv vs venv instructions.

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.

2 participants