Skip to content

Commit

Permalink
Merge pull request #7 from prajwal3104/main
Browse files Browse the repository at this point in the history
docs: Update index.md
  • Loading branch information
BRAVO68WEB authored Nov 10, 2024
2 parents 1490c14 + 641bc7a commit 6eda622
Showing 1 changed file with 25 additions and 20 deletions.
45 changes: 25 additions & 20 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,33 @@ title: Getting Started
nav_order: 1
---

## Getting Started
## Getting Started: Your Free Subdomain

- [Fork](https://github.com/ml-comm/ddns/fork) the ddns repository to your GitHub account
- Create a new file under the `domains` directory.
- Name the file according to the sub-domain name that you would like, for example `my-project.json`.
This guide explains how to get a free `*.ml-comm.ml` subdomain for your machine learning, data science, AI, or research project.

*The file path and name should look somewhat similar to this: `domains/my-project.json`*
- Read the format documentation [here](FORMAT.md) to see what json format you should be following.
- Check over your file to make sure that everything looks right and matches the format.
- Open a Issue first via [here](https://github.com/ml-comm/ddns/issues/new?assignees=&labels=request&projects=&template=REQUEST.yml&title=%5BREQUEST%5D%3A+) to discuss the subdomain you want to register.
- When your request is approved, open a pull request with the file you created.
- Check up on your pull request. Sometimes we will comment or add a new label, these can mean that you domain is unavailable or something is wrong with the file. If this is the case, don't worry! You are still able to get a domain, but you may have to either change the file name or check over the file again.
- Leave the rest down to us, we will make sure that the subdomain is sorted out.
- Once your pull request has been merged, enjoy the subdomain. If you ever need to change the subdomain, don't hesitate to open a new pull request to change any of the details.
**Steps:**

1. **Fork the Repository:** Fork the [ddns repository](https://github.com/ml-comm/ddns/fork) to your GitHub account. This creates a copy you can edit.

2. **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.ml-comm.ml`). The full path would be `domains/my-project.json`.
- **Important:** See the [format documentation](FORMAT.md) for the required JSON structure. Double-check your file for accuracy.

3. **Request Your Subdomain:** Open an issue on the main ddns repository using the [request template](https://github.com/ml-comm/ddns/issues/new?assignees=&labels=request&projects=&template=REQUEST.yml&title=%5BREQUEST%5D%3A+). Discuss your desired subdomain and any specific needs. This allows us to review and approve your request.

4. **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.

5. **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.

6. **Subdomain Activation:** We'll merge your pull request once everything is in order and activate your subdomain.

7. **Managing Your Subdomain:** You can update your subdomain settings at any time by submitting a new pull request with the modified JSON file.

---

Your pull request **will not** be merged if:
- The records provided includes invalid/unpermitted record types. If this happens we will notify you and request changes.
- It violates users privacy.
- It serves malicious content.
- Not related to Machine Learning / Data Science / Artificial Intelligence / Research.
- The subdomain is already taken.
## Important Considerations:

*If your subdomain is inactive, it may be purged. We will try and notify you before purging via the email you provided.*
* **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.

0 comments on commit 6eda622

Please sign in to comment.