Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

Update docs for flytectl update project #458

Merged
merged 4 commits into from
Jan 31, 2024

Conversation

ppiegaze
Copy link
Member

Update the docs for flytectl update project to accurately explain archiving and activating using a yaml file

Copy link

codecov bot commented Jan 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (79ed5ce) 67.69% compared to head (42a35a5) 67.69%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #458   +/-   ##
=======================================
  Coverage   67.69%   67.69%           
=======================================
  Files         148      148           
  Lines        6639     6639           
=======================================
  Hits         4494     4494           
  Misses       1855     1855           
  Partials      290      290           
Flag Coverage Δ
unittests 67.69% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

cosmicBboy
cosmicBboy previously approved these changes Jan 30, 2024
Copy link
Contributor

@cosmicBboy cosmicBboy left a comment

Choose a reason for hiding this comment

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

Seems like there's an rst syntax warning

/home/runner/work/flytectl/flytectl/flyte/docs/flytectl/gen/flytectl_update_project.rst:57:Bullet list ends without a blank line; unexpected unindent.

Comment on lines 94 to 96
* The *state* field only takes effect if the *archive* flag is present in the command.
* The *activate** flag is not used when updating a project using a *yaml* file.
Instead, a *state* field value of *0* in conjunction with the *archive* flag is used.
Copy link
Contributor

Choose a reason for hiding this comment

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

the error probably has to do with this bullet list

Signed-off-by: Peeter Piegaze <1153481+ppiegaze@users.noreply.github.com>
Signed-off-by: Peeter Piegaze <1153481+ppiegaze@users.noreply.github.com>
@ppiegaze ppiegaze force-pushed the docs/peeter/project-archive-with-yaml branch from 436aabc to 1273649 Compare January 31, 2024 13:08
Signed-off-by: Peeter Piegaze <1153481+ppiegaze@users.noreply.github.com>
@ppiegaze ppiegaze force-pushed the docs/peeter/project-archive-with-yaml branch from 31e0aad to 8886a17 Compare January 31, 2024 14:14
Signed-off-by: Peeter Piegaze <1153481+ppiegaze@users.noreply.github.com>
@ppiegaze ppiegaze merged commit 246745d into master Jan 31, 2024
15 checks passed
@ppiegaze ppiegaze deleted the docs/peeter/project-archive-with-yaml branch January 31, 2024 16:24
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
2 participants