Add docs for changing domain names

Open
#1,891 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
52/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start with the Sphinx documentation and review the linked forum answer and migration guide. Add guidance for both keeping the old domain with a CNAME redirect and completely replacing the domain using the domain update script approach. Done means users can choose the appropriate migration path from the docs.

Written by the indexing model from the issue text.

Description

This comes up occasionally on the forum and I think it should be in the docs.

  • If you have devices or dashboards that need to use that same old domain, use a CNAME redirect.
  • If you want a complete break from that domain, you can find/replace the domain by following the "Create Domain Update Script Files" section of @KagundaJM's migration guide.
Dominant language
Python
Stars
58
Forks
161
Avg merge
20h 51m
Merged PRs (30d)
2

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getodk/docs

All issues in getodk/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.