Commit Graph

17 Commits

Author SHA1 Message Date
Megan Marsh f179f01314 Modify struct-markdown generator code to work from different projct roots
Modify makefile to call generate code properly, setting project root.
'make generate' now avoids deleting website code generated in the packer plugin sdk.
For now it will be maintainers' responsibility to regenerate this docs code from the
packer plugin sdk every release, and commit it to these folders manually.
remove boot command generator code
2020-12-10 14:35:14 -08:00
Megan Marsh ea1ac530b0 move hcl2template kv types into the config/custom_types with trilean definitions 2020-11-18 15:46:59 -08:00
Jonathan Neal d8b67f8520
📌 Hard Pin Website Dependencies (#9543)
* Update and pin dependencies
* Update NextJS Scripts
* npm run lint
* npm run format
* docs generator: indent docs by two and make spacing better

Co-authored-by: Adrien Delorme <azr@users.noreply.github.com>
2020-07-13 12:33:16 +02:00
Megan Marsh 756d0760b5 remove unused import 2020-05-01 10:36:17 -07:00
Megan Marsh 7e0cfd8b77 add undocumented tag to struct-markdown generator so that we can leave internal-use-only fields out of docs 2020-05-01 10:31:38 -07:00
Adrien Delorme c5c3585df1 make docs a bit more readable for KeyValues too 2020-04-21 12:22:37 +02:00
Jeff Escalante 2999934326
fix generation script, bugfixes in source comments, update website paths in primary codebase 2020-04-07 17:53:22 -04:00
Adrien Delorme 78ac1e256b better type for []NameValue in docs 2020-03-17 15:02:04 +01:00
Adrien Delorme 0a46bb9525 more precise docs 2020-03-17 11:50:16 +01:00
jhawk28 ff1af40c66
struct-markdown should keep the same slash direction regardless of Windows or Linux (#8738) 2020-02-14 08:50:03 +01:00
Megan Marsh 69fe131571
switch trilean to boolean in docs to prevent confusion (#8673) 2020-01-31 16:42:16 +01:00
Adrien Delorme 819329228a Change back to make sure all durations are a time.Duration
It is simply the best/simplest solution and trying to prevent users from passing and integer here would be like opening a can of worms. Because:

* we cannot make mapstructure validate our duration string ( with an UnmarshalJSON func etc.)
* we cannot make mapstructure spit a string instead of a duration and packer will decode-encode-decode config.
* the hcl2 generated code asks for a string, so this will be enforced by default.
2019-10-31 16:12:07 +01:00
Adrien Delorme bf3d9841c6 Force durations to be passed a strings
Before this commit it was possible to set a duration using an integer or a float. Go's time.Duration is an int64 internally an mapstructure will take advantage of this and load the number as a int64 but `1` means one ns which is unexpected/confusing. To avoid confusion and enforce readability this forces users to pass a string with a unit for a duration; ex "56s".
2019-10-31 11:47:19 +01:00
Adrien Delorme 0fe48691e8 ignore doc fields containing `TODO` 2019-08-27 13:55:00 +02:00
Adrien Delorme ec52f36af1 docs: escape pointer (*) parameters `*` => `\*`
so that we don't get weird italics there and there
2019-08-27 13:30:50 +02:00
Adrien Delorme 349c3ef74b cmd/struct-markdown: also generate docs from header comments of a struct
& generate it for ISOConfig
2019-06-12 16:25:08 +02:00
Adrien Delorme 4ae10f08b2 docs: generate builders partials from struct comments 2019-06-06 17:34:17 +02:00