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

chore: add config policies to CLI reference docs #10118

Merged
merged 3 commits into from
Oct 24, 2024
Merged

Conversation

amandavialva01
Copy link
Contributor

@amandavialva01 amandavialva01 commented Oct 24, 2024

Ticket

CM-480

Description

  • Add config policies to CLI reference docs
  • give det config-policies shorthand name det cp
  • clarify in the config-policies help messages that policies are applied globally when --workspace-name flag is unspecified

Test Plan

Checklist

  • Changes have been manually QA'd
  • New features have been approved by the corresponding PM
  • User-facing API changes have the "User-facing API Change" label
  • Release notes have been added as a separate file under docs/release-notes/
    See Release Note for details.
  • Licenses have been included for new code which was copied and/or modified from any external code

@amandavialva01 amandavialva01 requested a review from a team as a code owner October 24, 2024 14:34
@cla-bot cla-bot bot added the cla-signed label Oct 24, 2024
@determined-ci determined-ci added the documentation Improvements or additions to documentation label Oct 24, 2024
@determined-ci determined-ci requested a review from a team October 24, 2024 14:34
Copy link

netlify bot commented Oct 24, 2024

Deploy Preview for determined-ui canceled.

Name Link
🔨 Latest commit a5d296c
🔍 Latest deploy log https://app.netlify.com/sites/determined-ui/deploys/671a6e97f7e87600081fd855

Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.47%. Comparing base (22ad457) to head (a5d296c).
Report is 15 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10118      +/-   ##
==========================================
- Coverage   54.49%   54.47%   -0.03%     
==========================================
  Files        1267     1267              
  Lines      159437   159437              
  Branches     3637     3635       -2     
==========================================
- Hits        86885    86850      -35     
- Misses      72419    72454      +35     
  Partials      133      133              
Flag Coverage Δ
backend 45.66% <ø> (-0.07%) ⬇️
harness 72.55% <ø> (ø)
web 54.02% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
harness/determined/cli/config_policies.py 16.36% <ø> (ø)

... and 10 files with indirect coverage changes

@amandavialva01 amandavialva01 changed the title add config policies to CLI reference docs chore: add config policies to CLI reference docs Oct 24, 2024
Admins are encouraged to draft and save their config policies for each scope in separate YAML or
JSON files. This allows for consistency between config policies set in the WebUI and CLI and
lessens the chance for unintended changes to be made to a given scope's policies.

Copy link
Contributor

Choose a reason for hiding this comment

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

Order is good.

I don't agree with the reasons for the suggestion though. The config policies will be consistent if set via webUI or CLI whether admins draft them separately or not. That makes it sound like there's a bug in our APIs or something.

I think the reason to suggest admins draft it separately is that our webUI does not support common helpful features like "save", "undo", or any kind of history.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The config policies will be consistent if set via webUI or CLI whether admins draft them separately or not. That makes it sound like there's a bug in our APIs or something.

Hmm, I guess I meant consistency on their end (so that they don't have one config used for the webUI policies and a different folder of configs whose paths are input into the CLI).
but that makes sense! I'll rephrase the benefits of the note

Copy link
Contributor

@azhou-determined azhou-determined left a comment

Choose a reason for hiding this comment

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

nice

@amandavialva01 amandavialva01 merged commit 186962c into main Oct 24, 2024
82 of 95 checks passed
@amandavialva01 amandavialva01 deleted the amanda/CLIDocs branch October 24, 2024 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants