Skip to content
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.

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

DOC: add License, Maintainers, and Funding sections #445

Merged
merged 3 commits into from
Aug 24, 2023

Conversation

dnicolodi
Copy link
Member

This replaces #354.

The left-hand-side index on the documentation pages gets again a bit too long, but I cannot think to an organization of these sections that makes sense and spares top level index entries. Suggestions are welcome.

@dnicolodi
Copy link
Member Author

@rgommers What's the copyright blurb we should use for the Quansight logo?

@dnicolodi dnicolodi changed the title DOC: add License, Maintainers, and Fundind sections DOC: add License, Maintainers, and Funding sections Jul 15, 2023
@rgommers rgommers added the documentation Improvements or additions to documentation label Aug 23, 2023
@rgommers rgommers mentioned this pull request Aug 23, 2023
@rgommers
Copy link
Contributor

rgommers commented Aug 23, 2023

What's the copyright blurb we should use for the Quansight logo?

Good question. I think the options are:

  • leaving it out, or
  • simply "Copyright Quansight", or
  • something custom like "Copyright Quansight, approved for use by meson-python in its documentation, and including redistributions of meson-python without restrictions".

This has got to be a common question, because a ton of projects use logos like this. I'm not aware of a single canonical way to treat copyright statements though - I'll do some searching.

@rgommers
Copy link
Contributor

Common question, but there is no good answer. I think it's actually an annoyance for packagers to have this logo image included, because it is the kind of thing that has to be treated with care. For most projects this doesn't come up because logos go on a website, which is kept in a separate repo from the code and docs so there's no cross-talk to an sdist and other redistributable artifacts for the software package.

The easiest thing here is to get rid of it. That's too bad, but attribution in text is also fine.

Copy link
Contributor

@rgommers rgommers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM modulo my couple of minor comments.

docs/about.rst Outdated Show resolved Hide resolved
docs/about.rst Outdated Show resolved Hide resolved
docs/about.rst Outdated Show resolved Hide resolved
@rgommers
Copy link
Contributor

also, pre-commit has a nitpick

@dnicolodi
Copy link
Member Author

pre-commit complains about the Quansight logo SVG not terminating in a newline. Issue will go away if we renounce to include the logo. Indeed having third party logos in the source distribution is a pain, but it is also too bad to do not give visibility to companies that contribute to free software.

@dnicolodi
Copy link
Member Author

All fixed. I've also added one more commit on top. PTAL

Copy link
Contributor

@rgommers rgommers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM, thanks. Renaming Security to Packages sounds good to me, because it's not really about Security. For a section named Security, I'd expect a security vulnerability disclosure policy or some such thing.

Please consider my proposed rephrase - either way this is good to go in.

docs/about.rst Outdated Show resolved Hide resolved
docs/about.rst Outdated Show resolved Hide resolved
@rgommers rgommers added this to the v0.14.0 milestone Aug 24, 2023
@dnicolodi dnicolodi merged commit a6eb22a into mesonbuild:main Aug 24, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants