Drupal Version

There is currently only documentation for 7.x version of the module, https://www.drupal.org/documentation/modules/domain.

Since no official documentation exists for 2.0.x and 3.x, creating this issue as a starting point.

Domain module version

Documentation would focus on 2.0.x and 3.x versions

Documentation needs

[What did you try to do? What URL did you use to do it?]

Tasks

  • ✅ File the issue
  • ☐ Review existing documentation and instructions, related issues, roadmap, and support requests
  • ☐ Create Outline

Issue fork domain-3366588

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

bsnodgrass created an issue. See original summary.

bsnodgrass’s picture

bsnodgrass commented
Issue summary: View changes

I would appreciate any feedback or suggestions for documentation on this project.

Initially, I am looking for any existing work on instructions or experience.

bsnodgrass’s picture

bsnodgrass commented
Title: Documentation for 2.x » Documentation for 2.0.x
Issue tags: +Needs documentation
davps’s picture

davps commented
Version: 2.0.0-beta1 » 2.0.x-dev
Assigned: bsnodgrass » Unassigned
Category: Task » Plan
kiwad’s picture

kiwad commented

I would suggest also to review the module page presentation.

The section "Technical background" gives outdated links from 15+ years ago

danrod’s picture

danrod
Location Ottawa
commented

Thanks @kiwad , I noticed it.

I'll find some time today to update some pages: https://www.drupal.org/documentation/modules/domain

danrod’s picture

danrod
Location Ottawa
commented
Assigned: Unassigned » danrod
mably’s picture

mably commented

And 3.x too 😉

danrod’s picture

danrod
Location Ottawa
commented

Alright, will do.

mably’s picture

mably commented

Documentation for the 3.x branch should be written using Mkdocs md files in source code repository.

The README file has been used to initialize the documentation home page hosted on Gitlab Pages:

https://project.pages.drupalcode.org/domain/

mably’s picture

mably commented
Title: Documentation for 2.0.x » Documentation for 2.0.x and 3.x
Version: 2.0.x-dev » 3.x-dev
Issue summary: View changes

We should probably focus on 3.x first.

mably’s picture

mably commented

We should verify whether the project documentation requires updates before merging any issue.

The Needs documentation tag should be applied to issues that require documentation updates.

mably’s picture

mably commented

A link to the new documentation format is now available on the project page.

Contributions are welcome!

danrod’s picture

danrod
Location Ottawa
commented

Thanks a lot @mably , I see now the directory that feeds that doc page: https://git.drupalcode.org/project/domain/-/tree/3.x/docs?ref_type=heads

I'll review this and make some contributions if some item of feature is missing for description.

mably opened merge request !335

  • mably committed 12ebc18c on 3.x 
    plan: #3366588 Documentation for 2.0.x and 3.x

By: bsnodgrass
By: davps...
mably’s picture

mably commented
Assigned: danrod » Unassigned
Status: Active » Fixed
Issue tags: -Needs documentation

The mkdocs documentation for 3.x is now live at project.pages.drupalcode.org/domain/ and covers the full module suite:

  • Presentation — overview, requirements, installation, cross-domain logins, CORS, trusted hosts, domain record configuration, validation rules, caching, contributing guidelines
  • Domain — cross-domain URL rewriting API, experimental features (language negotiation, destination redirects, early negotiation)
  • Domain Access — fields, node access grants, permissions, settings, Views integration, bulk actions, condition plugin, hooks, services
  • Domain Alias — pattern matching, wildcards, ports, redirects, environments, validation, Drush commands
  • Domain Config — 2.x vs 3.x architecture comparison, config collections, override resolution, caching, lifecycle events, export/import, 2.x → 3.x migration
  • Domain Config UI — inline toggle, disallowed configurations, alter hooks, permissions
  • Domain Content — per-domain content and editor overview pages, Views (affiliated_content / affiliated_editors), access plugins, domain operations
  • Domain Source — canonical URLs, token, Metatag integration, excluded routes
  • Related contrib modules — Domain Extras, Domain Path, Domain Theme Switch

The latest MR also updates outdated references in the presentation page (Drupal version requirements, stale "Drupal 8" mentions, array() → [] syntax, bare URLs → proper links).

I think this can be marked as fixed — every included submodule now has a dedicated documentation page.

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

mably’s picture

mably commented

The documentation for Domain 3.x is now available in french:

https://project.pages.drupalcode.org/domain/fr/

danrod’s picture

danrod
Location Ottawa
commented

Thank you so much, I can translate the documentation in Spanish if needed, I know there's a plenty of spanish-speaker users who use this module, please let me now.

mably’s picture

mably commented

Thanks @danrod. I can ask Claude to draft an initial version so you can proofread it.

danrod’s picture

danrod
Location Ottawa
commented

Sure @mably thanks.

mably’s picture

mably commented

@danrod here it is #3578612: Add Spanish translation of mkdocs documentation.

danrod’s picture

danrod
Location Ottawa
commented

Hi @mably thanks, I'll review it today.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.