diff --git a/doc/_toc.yml b/doc/_toc.yml index 4a15a8ff..769d683d 100644 --- a/doc/_toc.yml +++ b/doc/_toc.yml @@ -13,6 +13,7 @@ parts: - file: user-guide/github - file: user-guide/env-vars - file: user-guide/custom-domains + - file: user-guide/managing-apps - caption: Sharing notebooks chapters: diff --git a/doc/static/custom-domains/custom-names.png b/doc/static/custom-domains/custom-names.png new file mode 100644 index 00000000..6e9ebbf4 Binary files /dev/null and b/doc/static/custom-domains/custom-names.png differ diff --git a/doc/static/manage-apps/add-label-from-status.png b/doc/static/manage-apps/add-label-from-status.png new file mode 100644 index 00000000..1a05ee23 Binary files /dev/null and b/doc/static/manage-apps/add-label-from-status.png differ diff --git a/doc/static/manage-apps/labels.png b/doc/static/manage-apps/labels.png new file mode 100644 index 00000000..9281afff Binary files /dev/null and b/doc/static/manage-apps/labels.png differ diff --git a/doc/static/manage-apps/see-labels-main.png b/doc/static/manage-apps/see-labels-main.png new file mode 100644 index 00000000..3f306ed9 Binary files /dev/null and b/doc/static/manage-apps/see-labels-main.png differ diff --git a/doc/static/manage-apps/see-labels-status.png b/doc/static/manage-apps/see-labels-status.png new file mode 100644 index 00000000..46a1fb72 Binary files /dev/null and b/doc/static/manage-apps/see-labels-status.png differ diff --git a/doc/user-guide/custom-domains.md b/doc/user-guide/custom-domains.md index 09e964b3..2cfb0ff5 100644 --- a/doc/user-guide/custom-domains.md +++ b/doc/user-guide/custom-domains.md @@ -1,9 +1,28 @@ -# Custom domains +# Custom domains and subdomains When you publish your application for the first time, your web address (i.e., URL) is in the following format: `project-id.plooberapp.io` +Ploomber offers options to customize the [subdomain](#custom-subdomain) or the [full domain](#custom-domain). + If you already own a domain, you can easily bring it to your Ploomber account by updating your DNS records, or by changing its nameservers. +(custom-subdomain)= +## Adding a custom subdomain + +```{note} +Custom project names are a [paid feature.](../pricing/overview.md) +``` + +If you would like a custom subdomain, like `my-custom-app.ploomberapp.io`, you can add a custom name during application setup: + + + +Customizing the project name only changes the `x` portion in `x.ploomberapp.io`. + +If you would like a fully customized domain, see [Adding a custom domain](#custom-domain). + + +(custom-domain)= ## Adding a custom domain ### Before you begin diff --git a/doc/user-guide/managing-apps.md b/doc/user-guide/managing-apps.md new file mode 100644 index 00000000..5e485110 --- /dev/null +++ b/doc/user-guide/managing-apps.md @@ -0,0 +1,17 @@ +# Managing applications + +## Labels + +Labels can help you organize and identify your apps. You can add them during creation: + + + +Or add them from the application status page: + + + +You may add as many labels as you want. Once you've added some labels, they will show up on the status page and the main Applications page: + + + + \ No newline at end of file