Start of exhaustively documenting the build file. #609
Conversation
Signed-off-by: Ville Aikas <[email protected]>
|
There are bunch of TODO(vaikas) that I need some help with, so just jotted them down while I was writing. I'll keep iterating. |
docs/BUILD-FILE.md
Outdated
| # melange build file | ||
|
|
||
| This documents the melange build file structure, fields, when, and why to use | ||
| various fields. |
There was a problem hiding this comment.
Other folks might disagree, but IMO one line per sentence in markdown makes diffs a lot nicer.
There was a problem hiding this comment.
are you seriously suggesting on not wrapping at 80???
There was a problem hiding this comment.
@jonjohnsonjr my bad for disagreeing but as someone who spends a lot of time comparing markdown files I appreciate the wrapping 😬
docs/BUILD-FILE.md
Outdated
|
|
||
| Ordered list of pipelines that produce this package | ||
|
|
||
| And the following optional sections: |
There was a problem hiding this comment.
I'd have required and optional section headings as ## and unindent these bullet points (or make them ###).
There was a problem hiding this comment.
good idea, I'm not so good with markdown.
Signed-off-by: Ville Aikas <[email protected]>
|
Addressed feeback, and I added some great verbiage from @erikaheidi here. |
1 similar comment
|
Addressed feeback, and I added some great verbiage from @erikaheidi here. |
While learning about, couldn't really find one place to understand the build file, fields, etc. so figured I'd take a crack at creating one. Not comprehensive, but a start to see if keeping on going makes sense.