Skip to content

Commit

Permalink
requirements: Change wording and heading of ID domain requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
bbhtt committed Jul 25, 2024
1 parent f6571a2 commit f444ff1
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 13 deletions.
34 changes: 22 additions & 12 deletions docs/02-for-app-authors/02-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ com.0example.foo
unless the project is an official project of the code hosting
platform.

### Control over domain
### Control over domain or repository

- The author/developer/project of the application must have control
over the domain portion of the ID and the corresponding URL must be
Expand All @@ -66,21 +66,31 @@ com.0example.foo
`http(s)://foo.example-site.com` must be reachable and must be under
control of author/developer/project of the application.

- For code hosting IDs starting with `io.github.example_foo.bar, page.codeberg.example_foo.bar`
the repository must be reachable at `https://github.com/example-foo/bar` or
- For GitHub and Codeberg IDs of the form
`io.github.example_foo.bar, page.codeberg.example_foo.bar` the
repository must be reachable at `https://github.com/example-foo/bar` or
`https://codeberg.org/example-foo/bar` respectively.

For a Sourceforge ID starting with `io.sourceforge.example_foo.bar`, the
project URL must be reachable at `https://sourceforge.net/projects/example-foo`.
For Sourceforge IDs of the form
`io.sourceforge.example_foo.bar, net.sourceforge.example_foo.bar`, the
project URL must be reachable at
`https://sourceforge.net/projects/example-foo/`.

For `io.gitlab.example_foo.bar, io.frama.example_foo.bar, org.gnome.gitlab.example_foo.bar,
org.freedesktop.gitlab.example_foo.bar`, the repository must be reachable at
`https://gitlab.com/example-foo/bar` and so on. If there are more
components for example `io.gitlab.foo_1.bar_1.app`, the repository must
be reachable at `https://gitlab.com/foo-1/bar-1/app` and so on.
For Gitlab IDs of the form `io.gitlab.example_foo.bar,
io.frama.example_foo.bar, org.gnome.gitlab.example_foo.bar,
org.freedesktop.gitlab.example_foo.bar`, the repository must be
reachable at `https://gitlab.com/example-foo/bar` and so on.

Applications are not allowed to have >6 components in the IDs. This is
only allowed for baseapps and runtimes.
If there are more components for example
`io.gitlab.example_foo.example_bar.example-app`,
the repository must be reachable at
`https://gitlab.com/example-foo/example-bar/example-app`
and so on.

Note that Gitlab namespaces are case sensitive.

Applications are not allowed to have more than 6 components in the ID.
This is only allowed for baseapps and runtimes.

## License

Expand Down
2 changes: 1 addition & 1 deletion docs/02-for-app-authors/12-linter.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ error for the linter.
The URL determined from the domain portion of the appid was not
reachable.

Please see the [Control over domain](/docs/for-app-authors/requirements#control-over-domain)
Please see the [Control over domain or repository](/docs/for-app-authors/requirements##control-over-domain-or-repository)
section for more information.

### appid-code-hosting-too-few-components
Expand Down

0 comments on commit f444ff1

Please sign in to comment.