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

docs: Update domains page to include custom domain details #151

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

developerjamiu
Copy link
Contributor

@developerjamiu developerjamiu commented Mar 12, 2025

Description

  • Updated domains.mdx to include custom domain details.
  • Documentation change only, no functional updates.
  • Related to dart_globe Issue #955.

Type of Change

  • feat -- New feature (non-breaking change which adds functionality)
  • 🛠️ fix -- Bug fix (non-breaking change which fixes an issue)
  • ! -- Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 refactor -- Code refactor
  • ci -- Build configuration change
  • 📝 docs -- Documentation
  • 🗑️ chore -- Chore

@CLAassistant
Copy link

CLAassistant commented Mar 12, 2025

CLA assistant check
All committers have signed the CLA.

Copy link

📚 Documentation changes in this PR can be previewed here.

@alexdukeinvertase alexdukeinvertase removed their request for review March 12, 2025 09:23
@developerjamiu developerjamiu changed the title docs: update domains page to include custom domain details docs: Update domains page to include custom domain details Mar 12, 2025
@developerjamiu developerjamiu self-assigned this Mar 12, 2025
@developerjamiu developerjamiu added the documentation Improvements or additions to documentation label Mar 12, 2025
@developerjamiu developerjamiu marked this pull request as ready for review March 13, 2025 12:26

Custom domains are not yet supported. We are working on it.
Currently, each Globe project can have only one custom domain. To add a new domain, you must remove the existing one first. We will be adding support for multiple domains soon.
Copy link
Member

Choose a reason for hiding this comment

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

Could we say at a later date rather than "soon" - and link to the canny board if they want this?


Before adding a custom domain to Globe, update your DNS settings with your domain provider (e.g., GoDaddy, Google Domains, Cloudflare).

- Add a **CNAME record** pointing your domain to the value provided by Globe.
Copy link
Member

Choose a reason for hiding this comment

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

We should put the CNAME record in the docs - it should be static and never change. @kaziwaseef thoughts?

1. Go to the **Globe Dashboard**.
2. Select your project and navigate to **Domains**.
3. Click **Add Custom Domain**.
4. Enter your domain name (e.g., `example.com`).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
4. Enter your domain name (e.g., `example.com`).
4. Enter your domain name (e.g., `api.example.com`).

@kaziwaseef what are the restrictions on TLD? Wonder if we need to state here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants