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.

Sign up for GitHub

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

Expand-app-developers-pages #777

Merged
merged 9 commits into from
Nov 14, 2024
Merged

Expand-app-developers-pages #777

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
fa2c7bf
adds content to 2 app developer pages
hyounes4560 Oct 28, 2024
d0a12f6
Merge branch 'main' into expand-app-developers-pages
AidanDelaney Nov 4, 2024
f714d5e
adds dive and layers content
hyounes4560 Nov 9, 2024
cd2a8aa
Merge branch 'main' into expand-app-developers-pages
hyounes4560 Nov 9, 2024
5506ab5
adds default process content
hyounes4560 Nov 9, 2024
3f775e0
Merge branch 'expand-app-developers-pages' of github.com:hyounes4560/…
hyounes4560 Nov 10, 2024
4178e77
adds exp. features list
hyounes4560 Nov 12, 2024
ea3553a
adds reviewers feedback
hyounes4560 Nov 13, 2024
8279a06
Merge branch 'main' into expand-app-developers-pages
natalieparellano Nov 14, 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
18 changes: 18 additions & 0 deletions content/docs/for-app-developers/concepts/experimental-features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
+++
title="What are experimental features?"
weight=8
+++

Certain features are considered `experimental` and susceptible to change in a future API version.

Check warning on line 6 in content/docs/for-app-developers/concepts/experimental-features.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('are considered').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are considered').", "location": {"path": "content/docs/for-app-developers/concepts/experimental-features.md", "range": {"start": {"line": 6, "column": 18}}}, "severity": "INFO"}
hyounes4560 marked this conversation as resolved.
Show resolved Hide resolved

<!--more-->

This means users will need to enable the `experimental` mode in order to use one of these feature.

Check warning on line 10 in content/docs/for-app-developers/concepts/experimental-features.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "content/docs/for-app-developers/concepts/experimental-features.md", "range": {"start": {"line": 10, "column": 18}}}, "severity": "WARNING"}

Check warning on line 10 in content/docs/for-app-developers/concepts/experimental-features.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'to' instead of 'in order to'.

Raw Output:
{"message": "[Google.WordList] Use 'to' instead of 'in order to'.", "location": {"path": "content/docs/for-app-developers/concepts/experimental-features.md", "range": {"start": {"line": 10, "column": 62}}}, "severity": "WARNING"}
hyounes4560 marked this conversation as resolved.
Show resolved Hide resolved
hyounes4560 marked this conversation as resolved.
Show resolved Hide resolved

To enable these features, run `pack config experimental true`, or add `experimental = true` to the `~/.pack/config.toml` file.
hyounes4560 marked this conversation as resolved.
Show resolved Hide resolved
hyounes4560 marked this conversation as resolved.
Show resolved Hide resolved

For example, exporting your application to disk in `OCI` layout format is an experimental feature available on `pack` since version `v0.30.0`

Check warning on line 14 in content/docs/for-app-developers/concepts/experimental-features.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'app' instead of 'application'.

Raw Output:
{"message": "[Google.WordList] Use 'app' instead of 'application'.", "location": {"path": "content/docs/for-app-developers/concepts/experimental-features.md", "range": {"start": {"line": 14, "column": 29}}}, "severity": "WARNING"}

For more information and to look at an example of how this might be valuable, see [Export to OCI layout format on disk][exp-feature].

Check warning on line 16 in content/docs/for-app-developers/concepts/experimental-features.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'OCI', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'OCI', if it's unfamiliar to the audience.", "location": {"path": "content/docs/for-app-developers/concepts/experimental-features.md", "range": {"start": {"line": 16, "column": 94}}}, "severity": "INFO"}
hyounes4560 marked this conversation as resolved.
Show resolved Hide resolved

[exp-feature]: https://buildpacks.io/docs/for-app-developers/how-to/special-cases/export-to-oci-layout/
hyounes4560 marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 2 additions & 2 deletions content/docs/for-app-developers/how-to/build-outputs/understand-failures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ weight=99
summary="How to troubleshoot when things go wrong."
+++

This page is a stub! The CNB project is applying to [Google Season of Docs](https://developers.google.com/season-of-docs/docs/timeline) to receive support for improving our documentation. Please check back soon.
While `Buildpacks` help developers transform applications' source code into container images that can run on any cloud, creating an error-free experience remains far from achieved.
hyounes4560 marked this conversation as resolved.
Show resolved Hide resolved

If you are familiar with this content and would like to make a contribution, please feel free to open a PR :)
This guide explores some of the most common issues that may prevent image build completion and provides troubleshooting tips to help end-users navigate these issues.
hyounes4560 marked this conversation as resolved.
Show resolved Hide resolved
natalieparellano marked this conversation as resolved.
Show resolved Hide resolved
Loading