Skip to content

Credit article authors #543

Description

@fricklerhandwerk

Observations
It's not evident for readers – and tedious to figure out – who wrote a particular article (and similarly, who maintains it).

Problem
Authors are not credited appropriately. This is a particular problem now that nix.dev is transferred to the NixOS Foundation, while @domenkozar provided the bulk of the original material. We also expect many more tutorial and guide authors to make new contributions, and those should be credited as well.

Approaches

  • provide links to GitHub's blame view or contributors listing
    • the most accurate, requires least amount of maintenance once set up
    • probably more tricky to set up, may require custom code
  • use Sphinx's codeauthor directive in documents
    • allows for more control, can highlight the original author(s) of a document (who usually account for the largest part of its contents over its lifetime)
  • use CODEOWNERS to help communicating with maintainers
    • this is more interesting for the contribution and review process than for assigning credit

Priorities

Add 👍 to issues you find important.

Metadata

Metadata

Assignees

Labels

siteImprovements to the site infrastructure or content presentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions