Skip to content

Initial docs for Dockerfiles#526

Closed
natalieparellano wants to merge 9 commits intomainfrom
extensions-phase-2
Closed

Initial docs for Dockerfiles#526
natalieparellano wants to merge 9 commits intomainfrom
extensions-phase-2

Conversation

@natalieparellano
Copy link
Copy Markdown
Member

@natalieparellano natalieparellano commented Oct 12, 2022

Signed-off-by: Natalie Arellano <narellano@vmware.com>
@natalieparellano
Copy link
Copy Markdown
Member Author

Marking as draft as there are still some TODOs in the doc (links to pages that don't exist). But I think this is ready for some test-driving...

@natalieparellano natalieparellano marked this pull request as draft October 12, 2022 19:31
Natalie Arellano added 2 commits October 12, 2022 15:35
Signed-off-by: Natalie Arellano <narellano@vmware.com>
Signed-off-by: Natalie Arellano <narellano@vmware.com>
Copy link
Copy Markdown
Member

@AidanDelaney AidanDelaney left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general, I like these docs. They're well written. There are a few TODO's to tidy up and I'd like a pack release and the samples PR to land before we land these docs. I have ideas on how to restructure docs, but I think concrete docs like these are more important than waiting for abstract ideas to become real. We might restructure these docs if we refactor the presentation of all docs. In short, these are great :)

Comment on lines +35 to +42
```
.
├── extension.toml <- similar to a buildpack buildpack.toml
├── bin
│ ├── detect <- similar to a buildpack ./bin/detect
│ ├── generate <- similar to a buildpack ./bin/build
```

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this :)

Comment on lines +114 to +115
extensions in builds - will need additional updating to propagate changes such as a switched run image back to the
appropriate resource to avoid breaking rebase.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think readers of this document will be interested in technical details behinf kpack or will they be interested in a supported/not-supported decision?

Suggested change
extensions in builds - will need additional updating to propagate changes such as a switched run image back to the
appropriate resource to avoid breaking rebase.
extensions in builds - will need additional updating to propagate changes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a support/not-supported is what I'd care about and then a link to more details on how to enable it.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've restructured it a bit... LMK how it looks now

Comment on lines +122 to +133
### 0. Setup workspace directory

* `workspace=<your preferred workspace directory>`

### 1. Clone the pack repo and build it (TODO: remove when pack with extensions-phase-2 support is released)

* `cd $workspace`
* `git clone git@github.com:buildpacks/pack.git`
* `cd pack`
* `git checkout extensions-phase-2`
* `make clean build`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm really hoping we can get a pack release out before these docs land. Then you don't have to explain this to users.

* `cd $workspace`
* `git clone git@github.com:buildpacks/samples.git`
* `cd samples`
* `git checkout extensions-phase-2` (TODO: remove when `extensions-phase-2` merged)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should really merge this before releaing the docs.

Natalie Arellano and others added 5 commits October 21, 2022 13:18
Co-authored-by: Aidan Delaney <adelaney21@bloomberg.net>
Co-authored-by: Terence Lee <hone02@gmail.com>
Signed-off-by: Natalie Arellano <narellano@vmware.com>
Signed-off-by: Natalie Arellano <narellano@vmware.com>
Signed-off-by: Natalie Arellano <narellano@vmware.com>
Signed-off-by: Natalie Arellano <narellano@vmware.com>
Signed-off-by: Natalie Arellano <narellano@vmware.com>
@natalieparellano
Copy link
Copy Markdown
Member Author

I added a buildpack & platform migration guide and added some stuff about shell removal / overridable process args in the process. Hopefully it doesn't make the PR too difficult to parse. Still some sections to be added which I will get to shortly!

Signed-off-by: Natalie Arellano <narellano@vmware.com>
@natalieparellano
Copy link
Copy Markdown
Member Author

Closing in favor of #527

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document Dockerfiles feature (phase 1)

3 participants