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

Add more info on the scheduler group issues #467

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

Conversation

nkaretnikov
Copy link

@nkaretnikov nkaretnikov commented May 27, 2024

Reference Issues or PRs

Related:

Despite what these two issues say, the docs are correct. Jobs are scheduled even if only the admin group is used. I've just double-checked. An error is also already shown when there's a permission error. So I've just added more information on how the groups should be configured and some troubleshooting info.

What does this implement/fix?

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?

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 May 27, 2024

Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit 961d960
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/66586a2bed04cf000828fe9e
😎 Deploy Preview https://deploy-preview-467--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.

If your user is not part of one of the mentioned groups, you might see an error
like this one when clicking on the job details:

`Server returned status code 403 with message: 'workflows.argoproj.io is forbidden: User "system:serviceaccount:dev:argo-viewer" cannot create resource "workflows" in API group "argoproj.io" in the namespace "dev"`
Copy link
Author

Choose a reason for hiding this comment

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

Note: I use single backticks here on purpose: it allows showing the entire message inline and wraps it around to content width while still formatting it as monospace. Using three backticks would either make it too long (if one line) or would require breaking it into multiple lines (but then it would be harder for users to find this message if they search the docs by error message).


<div align="center">
<img src="/img/tutorials/jupyter-scheduler-permission-error.png" alt="Jupyter-Scheduler UI - permission error." width="100%"/>
</div>
Copy link
Author

Choose a reason for hiding this comment

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

This image pretty much duplicates the text above, but I think it's nice to have both here. The textual error is good for search and the image is good for figuring out where to look or how it should look in the UI.

@viniciusdc
Copy link
Contributor

Thanks for double-checking it, @nkaretnikov. This looks good to me already, though can you also add an FAQ section on this error? Maybe describe it lightly in the FAQ and point to this document for a general overview.

@nkaretnikov
Copy link
Author

@viniciusdc Added FAQ, moved notes closer to the beginning of the page. Added paragraphs, so they could be referenced. PTAL.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo 📬
Development

Successfully merging this pull request may close these issues.

None yet

2 participants