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

Update docs to use JHub App Launcher #397

Merged
merged 9 commits into from
Feb 13, 2024
Merged

Conversation

pavithraes
Copy link
Member

@pavithraes pavithraes commented Jan 11, 2024

Reference Issues or PRs

Closes #394

What does this implement/fix?

  • 🔧 Remove announcement about qhub->nebari migration
  • 📝 Move login-keyclock.md from How-tos to Tutorials, and update it to use JHub apps launcher
  • 📝 Rename creating-cds-dashboard.md to create-dashboard.md and update it include JHub apps launcher
  • 📝 Update FAQ about dashboard envs
  • 🔧 Miscellaneous link fixes

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests? N/A

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

Copy link

netlify bot commented Jan 11, 2024

Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit 3cb4018
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/65c2ee7f1b08190008aa684a
😎 Deploy Preview https://deploy-preview-397--nebari-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.

@pavithraes pavithraes added content: doc/tutorial Diataxis - tutorial needs: review 👀 This PR is complete and ready for reviewing labels Jan 11, 2024
@pavithraes pavithraes requested review from dcmcand and kcpevey January 12, 2024 13:27
@pavithraes pavithraes added this to the 2024.1.1 milestone Jan 12, 2024
@pavithraes pavithraes changed the title Update Authenticate and launch JupyterLab docs Update docs to use JHub App Launcher Jan 12, 2024
@pavithraes pavithraes requested a review from aktech January 15, 2024 13:36
@pavithraes pavithraes mentioned this pull request Jan 15, 2024
18 tasks
@pavithraes pavithraes self-assigned this Jan 16, 2024

There are several example dashboards to build in the dashboard_examples folder on Nebari. The `environment.yml` file in this folder can be used to build an environment that can run each of the dashboard examples available.
When deploying an app with JHub App Launcher, you need to have the following in your environemtn:
- `jhub-apps` package
Copy link
Member

Choose a reason for hiding this comment

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

Ideally we would have jhub-apps-client for this, which when we have it released, should package the minimal things like jhsingle-native-proxy, bokeh-root-cmd and a few, but it's fine for now.

docs/docs/faq.md Outdated Show resolved Hide resolved
pavithraes and others added 2 commits February 7, 2024 08:03
Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
Copy link
Member

@aktech aktech 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 to merge to me, we'll have to change the screenshots when the new design is live but its a future problem.

Nice work! 🎉

@aktech aktech merged commit 97f36a9 into nebari-dev:main Feb 13, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content: doc/tutorial Diataxis - tutorial needs: review 👀 This PR is complete and ready for reviewing
Projects
Status: Done 💪🏾
Status: Done 💪🏾
Development

Successfully merging this pull request may close these issues.

[DOC] - Launch apps with jhub-apps launcher
3 participants