Skip to content
This repository was archived by the owner on May 27, 2024. It is now read-only.

Create an FAQ #18

Merged
merged 44 commits into from
Jul 5, 2019
Merged

Create an FAQ #18

merged 44 commits into from
Jul 5, 2019

Conversation

carmenbianca
Copy link
Member

No description provided.

@carmenbianca
Copy link
Member Author

TODO: What to do with MIT/BSD licenses?

@mxmehl
Copy link
Member

mxmehl commented Apr 18, 2019

TODO: What to do with MIT/BSD licenses?

Added with my most recent commit

@silverhook
Copy link
Collaborator

TODO: What to do with MIT/BSD licenses?

See #16

@carmenbianca
Copy link
Member Author

I've been answering a lot of questions. I've left the questions that may require some legal finesse alone. Namely:

  • Is there a standard format for declaring copyright?
  • Which years do I include in the copyright statement?
  • What are license exceptions and what do I do with them?
  • Do I use SPDX-Copyright, Copyright, or ©?
  • Which files are copyrightable?
  • What is a copyright holder, and what is an author?
  • How to deal with MIT/BSD licenses which include copyright information themselves? (see Better handle licenses that have SPDX templates/variables (e.g. MIT, BSD) #16)

I have also not yet answered some other questions, but those are simply TODO.

@silverhook Would it be possible for you to answer these questions? Or ought I simply give them a spin, and you can proofread them for me?

Thanks!

@mxmehl
Copy link
Member

mxmehl commented Apr 25, 2019

We could consider using custom ids for the headings since you interlink a few of them.

By default, hugo sets an id based on the heading's content. If we edit a question, it might break existing links. But it's possible to do something like:

## I am short on time. Can you give me the quickest possible summary? {#quick}

## How do I exclude a file from REUSE compliance testing? {#exclude-files}

This way, sharing links to the FAQ would also be safer and shorter.

@carmenbianca
Copy link
Member Author

I did not know that was possible. I'll get on that now.

@carmenbianca
Copy link
Member Author

Did some work on reuse-website to see if the new IDs would work using Hugo: fsfe/reuse-website#1

They unfortunately do not work quite as expected. I'll demonstrate using a screenshot:

Ekrankopio de 2019-04-26 13-54-13

The link redirects to localhost/#custom-license instead of localhost/faq/#custom-license. I think there's a way to fix that in Hugo, but I haven't used Hugo in a while.

Moreover, the headers are far too big in the HTML version, but that all can be fixed later.

@carmenbianca carmenbianca merged commit 83e2915 into master Jul 5, 2019
@silverhook
Copy link
Collaborator

silverhook commented Jul 8, 2019

@carmenbianca, if there are still any FAQ entries open where I could help with, feel free to open a new issue and assign it to me. I kind of lost count by now.

@mxmehl mxmehl deleted the faq branch March 21, 2021 12:15
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants