Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement refactor rfc #658

Merged
merged 40 commits into from
Feb 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
785919a
Make landing spot for new content
natalieparellano Feb 12, 2024
13415cb
Changes needed to run `make serve`
natalieparellano Feb 12, 2024
3e2d40d
Make indices for tutorials
natalieparellano Feb 12, 2024
5f664e5
Move content to operators how-to
natalieparellano Feb 13, 2024
56d9346
Move platform migration guides to operators how-to
natalieparellano Feb 13, 2024
66e980d
Move tools to operators how-to
natalieparellano Feb 13, 2024
9b5b319
Move source metadata to operators how-to
natalieparellano Feb 13, 2024
7406eff
Nest platform/how-to build inputs as the tree was getting a little long
natalieparellano Feb 13, 2024
4a8bc36
Remove platform guide
natalieparellano Feb 13, 2024
4af9073
Move buildpack migration guides to buildpack-authors how-to
natalieparellano Feb 13, 2024
c750f4b
Move extension guide to buildpack-authors tutorial
natalieparellano Feb 13, 2024
2115e24
Move advanced extensions to buildpack-authors how-to
natalieparellano Feb 13, 2024
0ff738f
Split extension guide into developer & operator how-to
natalieparellano Feb 13, 2024
24f1cb3
Split features into app-developer & platform-operator
natalieparellano Feb 13, 2024
3190e73
Split buildpack author guide (except tutorial) into concepts and how-to
natalieparellano Feb 13, 2024
504bdb6
Split app developer guide into how-to
natalieparellano Feb 13, 2024
02aa484
Touch up titles & summaries
natalieparellano Feb 13, 2024
f5dd299
Fix broken links
natalieparellano Feb 13, 2024
4cb6858
Rename some things for consistency
natalieparellano Feb 13, 2024
06d109d
Fix broken links
natalieparellano Feb 13, 2024
270bfd9
Move concepts lifecycle into platform concepts
natalieparellano Feb 13, 2024
2bb85cf
Fix broken links
natalieparellano Feb 13, 2024
e800e05
Move concepts around
natalieparellano Feb 13, 2024
c4bba6a
Fix broken links
natalieparellano Feb 13, 2024
e8bb3e3
Move buildpack author tutorial to buildpack author section
natalieparellano Feb 14, 2024
a5e65c8
Break apart buildpack tutorial
natalieparellano Feb 14, 2024
0aa2350
Fix broken links
natalieparellano Feb 14, 2024
25a1178
Clean up app-dev concepts
natalieparellano Feb 14, 2024
389505d
Clean up app-dev how-to
natalieparellano Feb 14, 2024
e272dda
Clean up buildpack-author tutorials
natalieparellano Feb 14, 2024
b302ea2
Clean up buildpack-author concepts and how-to
natalieparellano Feb 14, 2024
a1e2e6c
Clean up platform-operator section
natalieparellano Feb 14, 2024
a7a12c0
Add stubs for missing content
natalieparellano Feb 14, 2024
2d6b82e
More cleanup
natalieparellano Feb 14, 2024
fdb94f3
More cleanup
natalieparellano Feb 14, 2024
b44856e
Update content/docs/for-buildpack-authors/how-to/write-buildpacks/spe…
natalieparellano Feb 15, 2024
44c6eed
Update stub language
natalieparellano Feb 16, 2024
28d716a
Add aliases
natalieparellano Feb 16, 2024
f83f77d
Demonstrate the use of symbolic links to avoid duplicative content
natalieparellano Feb 16, 2024
439e95e
Add back deleted aliases
natalieparellano Feb 16, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ $RECYCLE.BIN/
*.iml

# Generated files
content/docs/tools/pack/cli/pack*
content/docs/for-platform-operators/how-to/integrate-ci/pack/cli/pack*

# Hugo
.hugo_build.lock
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,9 @@ install-ugo:
.PHONY: pack-docs-update
pack-docs-update: upgrade-pack
@echo "> Updating Pack CLI Documentation"
@echo "> SHA of contents (before update):" `find ./content/docs/tools/pack -type f -print0 | xargs -0 sha1sum | sha1sum | cut -d' ' -f1`
@echo "> SHA of contents (before update):" `find ./content/docs/for-platform-operators/how-to/integrate-ci/pack -type f -print0 | xargs -0 sha1sum | sha1sum | cut -d' ' -f1`
cd tools; go run -mod=mod get_pack_commands.go
@echo "> SHA of contents (after update):" `find ./content/docs/tools/pack -type f -print0 | xargs -0 sha1sum | sha1sum | cut -d' ' -f1`
@echo "> SHA of contents (after update):" `find ./content/docs/for-platform-operators/how-to/integrate-ci/pack -type f -print0 | xargs -0 sha1sum | sha1sum | cut -d' ' -f1`

.PHONY: pack-version
pack-version: export PACK_VERSION:=$(PACK_VERSION)
Expand Down
2 changes: 1 addition & 1 deletion content/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ If you didn't find anything you'd like to improve while going through the tutori
[talks]: /docs/#talks
[tutorials]: /docs/#tutorials
[spec]: /docs/reference/spec/
[platforms]: /docs/concepts/components/platform/
[platforms]: /docs/for-app-developers/concepts/platform/
[pack]: https://github.com/buildpacks/pack
[lifecycle]: https://github.com/buildpacks/lifecycle
[docs]: https://github.com/buildpacks/docs
Expand Down
28 changes: 12 additions & 16 deletions content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,23 @@ summary="Get started with Cloud Native Buildpacks."
## Tutorials

* [An App’s Brief Journey from Source to Image](/docs/app-journey/) - An easy-to-follow introduction to Cloud Native Buildpacks using `pack`, a command line tool for Cloud Native Buildpacks.
* [Creating a Cloud Native Buildpack](/docs/buildpack-author-guide/create-buildpack) - Tutorial walking through the creation of a simple Ruby buildpack.
* [Creating a Cloud Native Buildpack](/docs/for-buildpack-authors/tutorials/basic-buildpack) - Tutorial walking through the creation of a simple Ruby buildpack.

## [Concepts](/docs/concepts)
## Going deeper

Learn the [concepts](/docs/concepts) of Cloud Native Buildpacks.
See how-to guides, concepts, and tutorials tailored to specific personas:

## Guides
* [App Developers](/docs/for-app-developers/)
* [Buildpack Authors](/docs/for-buildpack-authors/)
* [Operators](/docs/for-platform-operators/)

Set of guides tailored to specific personas:
## [Tools](/docs/for-platform-operators/)

* [App Developers](/docs/app-developer-guide/)
* [Buildpack Authors](/docs/buildpack-author-guide/)
* [Operators](/docs/operator-guide/)

## [Tools](/docs/tools/)

* **[CircleCI](/docs/tools/circleci)** - {{< summary "/docs/tools/circleci" >}}
* **[GitLab](/docs/tools/gitlab)** - {{< summary "/docs/tools/gitlab" >}}
* **[kpack](/docs/tools/kpack)** - {{< summary "/docs/tools/kpack" >}}
* **[Pack](/docs/tools/pack)** - {{< summary "/docs/tools/pack" >}}
* **[Tekton](/docs/tools/tekton)** - {{< summary "/docs/tools/tekton" >}}
* **[CircleCI](/docs/for-platform-operators/how-to/integrate-ci/circleci)** - {{< summary "/docs/for-platform-operators/how-to/integrate-ci/circleci" >}}
* **[GitLab](/docs/for-platform-operators/how-to/integrate-ci/gitlab)** - {{< summary "/docs/for-platform-operators/how-to/integrate-ci/gitlab" >}}
* **[kpack](/docs/for-platform-operators/how-to/integrate-ci/kpack)** - {{< summary "/docs/for-platform-operators/how-to/integrate-ci/kpack" >}}
* **[Pack](/docs/for-platform-operators/how-to/integrate-ci/pack)** - {{< summary "/docs/for-platform-operators/how-to/integrate-ci/pack" >}}
* **[Tekton](/docs/for-platform-operators/how-to/integrate-ci/tekton)** - {{< summary "/docs/for-platform-operators/how-to/integrate-ci/tekton" >}}

## [Reference](/docs/reference/)

Expand Down
15 changes: 0 additions & 15 deletions content/docs/app-developer-guide/_index.md

This file was deleted.

6 changes: 3 additions & 3 deletions content/docs/app-journey.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ deploying your new image to your favorite cloud!

Windows image builds are now supported!

<a href="/docs/app-developer-guide/build-a-windows-app" class="button bg-blue">Windows build guide</a>
<a href="/docs/for-app-developers/how-to/special-cases/build-for-windows" class="button bg-blue">Windows build guide</a>

[builder]: /docs/concepts/components/builder/
[buildpack]: /docs/concepts/components/buildpack/
[builder]: /docs/for-platform-operators/concepts/builder/
[buildpack]: /docs/for-platform-operators/concepts/buildpack/
[samples-java-maven]: https://github.com/buildpacks/samples/tree/main/apps/java-maven
[pack-docs]: /docs/tools/pack/
9 changes: 0 additions & 9 deletions content/docs/buildpack-author-guide/_index.md

This file was deleted.

36 changes: 0 additions & 36 deletions content/docs/buildpack-author-guide/create-buildpack/_index.md

This file was deleted.

This file was deleted.

Loading
Loading