add tile author guide for new Kiln users #407
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
We have created an issue in Pivotal Tracker to manage this. Unfortunately, the Pivotal Tracker project is private so you may be unable to view the contents of the story. The labels on this github issue will be updated when the story is started. |
crhntr
changed the title
crhntr
changed the title
jaristiz
previously requested changes
Jul 6, 2023
crhntr
changed the title
crhntr
force-pushed
the
tile-author-guide
branch
2 times, most recently
from
0ddcae9
to
df33da9
Compare
abg
reviewed
Jul 27, 2023
crhntr
force-pushed
the
tile-author-guide
branch
from
1f2cffd
to
46c014d
Compare
This guide is for new tile authors to get started or modernize with kiln built tiles.
squashed commits:
- add docs for testing and go import
- add heading for kiln test
- make authoring template parts more useful
- better document the bootstrapping section
- improve documentation for caching compiled releases
- add Stemcell Lock info to commit message
- add shell script command versions
- add curl version for completness
- clairify ominous comment about buildpacks
- document kiln update-release's ability to cause kiln validate to fail
- fix typo
- add documentation on what each kiln release source can do
this is based on whether the release source implements component.ReleaseUploader
- add local tarballs section
- document kiln glaze
- replace some todos with first draft documentation
- use perm-links for example links
also fix typo in script
Thanks @spikymonkey for pointing out this was un-documented.
[ci skip]
crhntr
force-pushed
the
tile-author-guide
branch
from
46c014d
to
7229737
Compare
[ci skip]
crhntr
force-pushed
the
tile-author-guide
branch
from
7229737
to
ae0d3ff
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a response to a request to help tile authors switch to Kiln from tile-generator or other tools and for existing kiln users to better understand and use the tool.
It has my opinions that are informed by PPE's kiln usage.
Some of the content in this file is already in the README. This is duplicate documentation but I think this is a good thing. The README is more in-depth; this is more beginner friendly.