Skip to content

ADD userguide/adding-an-app#6376

Merged
khanhtc1202 merged 2 commits into
pipe-cd:masterfrom
eeshaanSA:userguide/adding-app
Jan 8, 2026
Merged

ADD userguide/adding-an-app#6376
khanhtc1202 merged 2 commits into
pipe-cd:masterfrom
eeshaanSA:userguide/adding-app

Conversation

@eeshaanSA
Copy link
Copy Markdown
Contributor

What this PR does: Add managing-application/adding-an-application

File by file commit from the bigger PR - #6345

Why we need it:

Which issue(s) this PR fixes:

Fixes #

Does this PR introduce a user-facing change?:

  • How are users affected by this change:
  • Is this breaking change:
  • How to migrate (if breaking change):

@eeshaanSA eeshaanSA requested a review from a team as a code owner December 15, 2025 14:05
@eeshaanSA
Copy link
Copy Markdown
Contributor Author

@khanhtc1202, please check! 🙌

Comment on lines +24 to +48
{{< tabpane >}}
{{< tab lang="yaml" header="Kubernetes Application" >}}
# For application's configuration in detail for a Kubernetes Application, please visit
# https://pipecd.dev/docs/user-guide/managing-application/defining-app-configuration/kubernetes/

apiVersion: pipecd.dev/v1beta1
kind: Application
spec:
name: foo
labels:
team: bar
{{< /tab >}}
{{< tab lang="yaml" header="Terraform Application" >}}

# For application's configuration in detail for Terraform Application, please visit
# https://pipecd.dev/docs/user-guide/managing-application/defining-app-configuration/terraform/

apiVersion: pipecd.dev/v1beta1
kind: Application
spec:
name: foo
labels:
team: bar
{{< /tab >}}
{{< /tabpane >}}
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.

How about to make prepare piped plugins for your application docs separately and mention it here as pre-require for this docs 👀

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

What do you mean? If you want me to add something like a “Prerequisites” section here and link to separate docs about preparing PipeCD plugins?

Or do you mean something else?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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.

What do you mean? If you want me to add something like a “Prerequisites” section here and link to separate docs about preparing PipeCD plugins?

Yes, this is what I mean 👀

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
@eeshaanSA eeshaanSA force-pushed the userguide/adding-app branch from c79a3a6 to ed7afd4 Compare December 22, 2025 12:42
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
@eeshaanSA
Copy link
Copy Markdown
Contributor Author

Changges done, please check, @khanhtc1202, Thanks! Happy Holidays! 🎄

Copy link
Copy Markdown
Member

@khanhtc1202 khanhtc1202 left a comment

Choose a reason for hiding this comment

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

🚀

@khanhtc1202 khanhtc1202 merged commit 36bca36 into pipe-cd:master Jan 8, 2026
58 of 60 checks passed
khanhtc1202 pushed a commit that referenced this pull request Jan 9, 2026
* ADD userguide/adding-an-app

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

* UPDATE managing-app.md

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

---------

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>
@rahulshendre
Copy link
Copy Markdown
Contributor

@eeshaanSA, the image for “Registering an Application from Suggestions” under Adding an application is not loading on the live v1 docs page.
I checked it and is due to an incorrect image path. I’ve fixed it locally and verified the image loads correctly.
Let me know if I should open a PR for this : )

@eeshaanSA
Copy link
Copy Markdown
Contributor Author

@rahulshendre, sure! Thanks a lot!

>**NOTE:**
>Manually configuring the application on the Control Plane is not supported for PipeCD v1 deployments (deployment using plugins) as of now. We are working on this feature.

<!-- To define your application deployment pipeline which contains the guideline to show Piped how to deploy your application, please visit [Defining app configuration](../defining-app-configuration/). -->
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

we will also need to comment out this part, it links to defining app configuration.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@eeshaanSA, we have two issues here:

  • Incorrect image path on the live v1 docs
  • Reference to "Defining app configuration", which is not live yet

Either we can fix the image issue now in a small PR and handle the documentation section later once the page "Defining app configuration" is live, or do we wait and address both of them together in a single PR?
What would you suggest?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, Can you please open up issues for both? App configuration is pending, yes, and it should be made soon! Thanks!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

alright, will open up issues for both of them soon : )

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.

3 participants