-
Notifications
You must be signed in to change notification settings - Fork 404
docs: move is_dependency to correct function group #2761
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
Conversation
✅ Deploy Preview for devspace-docs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
df6ce29 to
24cf19a
Compare
lizardruss
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR!
It looks like there are some issues with our function partials generation script. The first being that it's not included in gendocs.sh. The second is that it's not placing these in the correct category.
If you get a chance to look into those issues, that would be great! Otherwise I can take a look soon.
|
I've tried running the partials generation script but it generates a whole heap of changes - they do seem correct but should they be included in this PR? For example: diff --git a/docs/pages/configuration/_partials/functions/is_empty.mdx b/docs/pages/configuration/_partials/functions/is_empty.mdx
index a2fadf770..ff55ba29b 100755
--- a/docs/pages/configuration/_partials/functions/is_empty.mdx
+++ b/docs/pages/configuration/_partials/functions/is_empty.mdx
@@ -3,9 +3,9 @@
<details className="config-field -function" data-expandable="false">
<summary>
-### `is_empty` <span className="config-field-type">[value]</span> <span className="config-field-enum"></span> <span className="config-field-default -return">bool</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_empty}
+### `is_empty` <span className="config-field-type">[value]</span> <span className="config-field-enum"></span> <span className="config-field-default -return">int</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_empty}
-Returns true if the value of the argument is empty string
+Returns exit code 0 if the value of the argument is empty string
</summary>
|
|
@jackwilsdon Thank you so much! Yeah I think including it in this PR would be good. Adding You've probably figured all this out, but I'm also just learning about this part of the document generation code 👍 |
24cf19a to
b32cf25
Compare
Signed-off-by: Jack Wilsdon <jack+github@wilsdon.me>
Signed-off-by: Jack Wilsdon <jack+github@wilsdon.me>
is_dependency can only be called from inside pipelines. Signed-off-by: Jack Wilsdon <jack+github@wilsdon.me>
Signed-off-by: Jack Wilsdon <jack+github@wilsdon.me>
Signed-off-by: Jack Wilsdon <jack+github@wilsdon.me>
b32cf25 to
926b3e2
Compare
|
I've updated this PR to include the changes discussed 👍 |
FabianKramm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jackwilsdon thanks a lot for the PR! LGTM!
What issue type does this pull request address? (keep at least one, remove the others)
/kind documentation
What does this pull request do? Which issues does it resolve? (use
resolves #<issue_number>if possible)Moves
is_dependencyfrom the "Global Functions" section of the built-in functions list to the "Pipeline-Only Functions" section (is_dependencyis pipeline-only).Please provide a short message that should be published in the DevSpace release notes
Updated classification of
is_dependencyin documentation.