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

Added 1-Click Deploy tutorial #160

Merged
merged 19 commits into from
Jan 17, 2025
Merged

Added 1-Click Deploy tutorial #160

merged 19 commits into from
Jan 17, 2025

Conversation

commit111
Copy link
Collaborator

@commit111 commit111 commented Jan 10, 2025

Fixes #161

  • added normal 1-click deploy tutorial
  • added custom 1-click deploy tutorial

@commit111 commit111 marked this pull request as ready for review January 10, 2025 00:02
Copy link
Contributor

@Prakash-Sundaresan Prakash-Sundaresan left a comment

Choose a reason for hiding this comment

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

Mostly looks good. Pls see specific comments.

docs/tutorials/using-one-click-deploy.md Outdated Show resolved Hide resolved
docs/tutorials/using-one-click-deploy.md Outdated Show resolved Hide resolved
docs/tutorials/using-one-click-deploy.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Prakash-Sundaresan Prakash-Sundaresan left a comment

Choose a reason for hiding this comment

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

Great work.
See detailed comments.

docs/tutorials/adding-custom-one-click-deploy.md Outdated Show resolved Hide resolved
docs/tutorials/adding-custom-one-click-deploy.md Outdated Show resolved Hide resolved
docs/tutorials/adding-custom-one-click-deploy.md Outdated Show resolved Hide resolved
docs/tutorials/adding-custom-one-click-deploy.md Outdated Show resolved Hide resolved
docs/tutorials/adding-custom-one-click-deploy.md Outdated Show resolved Hide resolved
docs/tutorials/using-one-click-deploy.md Outdated Show resolved Hide resolved
Comment on lines 2 to 7
title: Adding a Custom 1-Click Deploy
sidebar_position: 800
description: Add a custom 1-Click Deploy button to deploy your own app.
---

# Adding a Custom 1-Click Deploy
Copy link
Member

Choose a reason for hiding this comment

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

This title feels a little indirect. What do you think about something like this:

Suggested change
title: Adding a Custom 1-Click Deploy
sidebar_position: 800
description: Add a custom 1-Click Deploy button to deploy your own app.
---
# Adding a Custom 1-Click Deploy
title: Using 1-Click Deploy With Your Project
sidebar_position: 800
description: Add a custom 1-Click Deploy button to deploy your own app.
---
# Using 1-Click Deploy With Your Project

Copy link
Collaborator Author

@commit111 commit111 Jan 17, 2025

Choose a reason for hiding this comment

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

I tried to make the title as different from the "Using 1-Click Deploy" tutorial as possible, so that it's clear for new users which one to look for first. Maybe "Adding Custom 1-Click Deploy to an App" will be a better alternative?

Copy link
Member

@jordanstephens jordanstephens Jan 17, 2025

Choose a reason for hiding this comment

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

How about "Adding Custom 1-Click Deploy to your App"?

Or "Deploying Your App with 1-click Deploy"


This tutorial will show you how to use Defang 1-Click Deploy to deploy a sample to the Defang Playground.

The 1-Click Deploy button is intended to be a quickstart way for new users to deploy to the [Defang Playground](/docs/concepts/defang-playground) with no prior installation of the CLI needed.
Copy link
Member

Choose a reason for hiding this comment

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

What do you think about this? "quickstart way" felt a little ambiguous.

Suggested change
The 1-Click Deploy button is intended to be a quickstart way for new users to deploy to the [Defang Playground](/docs/concepts/defang-playground) with no prior installation of the CLI needed.
The 1-Click Deploy button is intended to be a quickstart guide to deploying an application to the [Defang Playground](/docs/concepts/defang-playground) with no prior installation of the CLI needed.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The button itself isn't a guide (as in an explicit tutorial) though, it's almost like a shortcut. Also, I think we should keep the word "new users" somewhere to make the distinction extremely clear between the other tutorial.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I do agree we can use a better wording than "way"

Copy link
Member

Choose a reason for hiding this comment

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

Ohh duh. Once again, not reading in the mindset of the reader.Maybe it would be better to come on a bit more confidently, and say something like this, but it's not super important.

Suggested change
The 1-Click Deploy button is intended to be a quickstart way for new users to deploy to the [Defang Playground](/docs/concepts/defang-playground) with no prior installation of the CLI needed.
The 1-Click Deploy button is the easiest way for new users to deploy your project to the [Defang Playground](/docs/concepts/defang-playground). No CLI installation is required.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This sentence is part of the tutorial for brand-new users, so it should not say "for new users to deploy your project". I agree with the other changes here though.

Copy link
Member

@jordanstephens jordanstephens left a comment

Choose a reason for hiding this comment

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

Made a few quick suggestions inline to tighten it up a little bit further, but this is looking excellent. Thank you Linda!

@commit111 commit111 merged commit d397e2e into main Jan 17, 2025
3 checks passed
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 1-click deploy
3 participants