This will add description about the new field appversion #461
Conversation
piyush-garg
changed the title
piyush-garg
changed the title
docs/file-reference.md
Outdated
| ``` |
There was a problem hiding this comment.
please don't change this line of code.
docs/file-reference.md
Outdated
|
|
||
| | Type | Required | Description | | ||
| |----------|--------------|--------------| | ||
| | string | yes | The version of the app or micro-service this particular file defines. | |
docs/file-reference.md
Outdated
| ## appversion | ||
|
|
||
| ```yaml | ||
| appversion: "5.0.0-alpha" |
There was a problem hiding this comment.
honestly, i'd put something like 0.0.1 instead of putting it in quotes. looks better / much easier.
There was a problem hiding this comment.
@cdrage I put it in quotes because, if someone is giving version as 5 or 5.1 then the user needs to give in quotes, it will work without quotes only in case of a string.
So I don't know what I should finally take as an example.
There was a problem hiding this comment.
Let's use quotes for now (to be save that this is really a string), and than we can change is based on how #407 will be implemented
There was a problem hiding this comment.
I think it's ugly to have quotes... The power of YAML is that it can be either one when unmarshaling.
Based on when #455 is merged, we can make it whatever we want it to be (int or string) if someone were to put a float or a version value.
There was a problem hiding this comment.
We can't merge this before #407 anyway, so let's wait for how it will be implemented.
piyush-garg
force-pushed
the
doc_add_field_appversion
branch
2 times, most recently
from
86bc1e7 to
4bfc292
Compare
piyush-garg
changed the title
docs/file-reference.md
Outdated
| @@ -136,6 +137,7 @@ Each "app" (Kedge file) is a Kubernetes <a target="_blank" href="https://v1-6.do | |||
| | Field | Type | Required | Description | | |||
| |----------|----------|--------------|--------------| | |||
| | name | string | yes | The name of the app or micro-service this particular file defines. | | |||
| | appversion | string | no | The version of the app or micro-service this particular file defines. | | |||
There was a problem hiding this comment.
hi @cdrage,
If you check name and controller field in the same table, it is written like this, if you still want the change then I will do.
Thanks
There was a problem hiding this comment.
yeah, both need to be changed 👍
piyush-garg
force-pushed
the
doc_add_field_appversion
branch
from
4bfc292 to
31cb13f
Compare
in file-reference.md This will add new key appversion in keys section and fix all the typos Fixed Typo
piyush-garg
force-pushed
the
doc_add_field_appversion
branch
from
31cb13f to
c1d83eb
Compare
|
LGTM |
This will add description about the new field appversion
in file-reference.md
#407