Skip to content

docs: Document journal and repo licenses #5190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joemull wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Document journal and repo licenses #5190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/md/images-in-reader-interface.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
- `press.Press.default_carousel_image`
- `press.Press.thumbnail_image`
- `journal.Journal.thumbnail_image`
- `submission.thumbnail_image_file`
- `submission.Article.thumbnail_image_file`
- `journal.Journal.default_cover_image`
- `journal.Issue.cover_image`
- `journal.Journal.header_image`
Expand Down
21 changes: 21 additions & 0 deletions docs/md/licences.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Licences

Intellectual property licences are given to articles in Janeway by means of the `submissions.models.Licence` object. Usually these are Creative Commons licences, but press managers and editors can create other licences with custom names, links, and descriptions.

## Journal licences

Journal article licences are particular to the journal. The journal is connected with the `journal` field.

When creating a journal, Janeway loads a default set of licences from a fixture located at `utils/install/licence.json`.

The fixture `core/fixtures/licence.json` is not used.

## Repository licences

Repository licences are not necessarily particular to the repository. They are defined by an empty value in the `journal` field, and whether they’ve been added to `Repository.active_licenses`.

When creating a repository, repository licences have to be manually created and added to the `active_licenses` field on the repository, using the Django admin interface.

## Connections to the press

The `press` field on the licence is typically blank.
Loading