Getting Started: Claim you Subdomain guide

This guide explains how to get a free *.mlcommunity.dev subdomain for your machine learning, data science, AI, or research project.

Steps:

Fork the Repository: Fork the ddns repository to your GitHub account. This creates a copy you can edit.
Create a Configuration File:
- In your forked repository, create a new JSON file inside the domains directory.
- Name the file after your desired subdomain (e.g., my-project.json for my-project.mlcommunity.dev). The full path would be domains/my-project.json.
- Important: See the format documentation for the required JSON structure. Double-check your file for accuracy.
Request Your Subdomain: Open an issue on the main ddns repository using the request template. Discuss your desired subdomain and any specific needs. This allows us to review and approve your request.
Submit a Pull Request: Once your request is approved, create a pull request from your forked repository to the main ddns repository, including your newly created JSON file.
Review and Adjustments: We may review your pull request and leave comments or labels if there are any issues (e.g., unavailable subdomain, formatting problems). Please address these and update your pull request as needed.
Subdomain Activation: We'll merge your pull request once everything is in order and activate your subdomain.
Managing Your Subdomain: You can update your subdomain settings at any time by submitting a new pull request with the modified JSON file.

Important Considerations:

Valid Records: Only permitted record types are allowed. We'll notify you if there are issues.
Acceptable Use: Subdomains must be related to machine learning, data science, AI, or research and cannot violate privacy, serve malicious content, or be used for illegal activities.
Inactivity: Inactive subdomains may be purged. We'll attempt to notify you via the email you provided before purging.
Denied Requests: We reserve the right to deny subdomain requests that don't meet these criteria.