forked from fsfe/reuse-website
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
used website data from reuse-docs and improve deployment
- Loading branch information
0 parents
commit 8698dd7
Showing
169 changed files
with
39,686 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
pipeline: | ||
syntaxcheck: | ||
image: monachus/hugo | ||
commands: | ||
- cd site; hugo | ||
|
||
deploy: | ||
commands: | ||
# Run docker compose | ||
- docker-compose up --build -d | ||
image: tmaier/docker-compose | ||
volumes: | ||
- /var/run/docker.sock:/var/run/docker.sock | ||
when: | ||
branch: master | ||
event: [push, tag, deployment] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
FROM php:7-apache | ||
|
||
ENV HUGO_VERSION 0.54.0 | ||
ENV HUGO_BINARY hugo_${HUGO_VERSION}_Linux-64bit.deb | ||
|
||
ADD https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/${HUGO_BINARY} /tmp/hugo.deb | ||
RUN dpkg -i /tmp/hugo.deb && \ | ||
rm /tmp/hugo.deb | ||
|
||
COPY ./site /tmp/reuse-web/ | ||
|
||
RUN hugo -s /tmp/reuse-web | ||
|
||
RUN rm -r /var/www/html && \ | ||
mv /tmp/reuse-web/public /var/www && \ | ||
mv /var/www/public /var/www/html && \ | ||
rm -r /tmp/reuse-web | ||
|
||
CMD apache2-foreground |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# REUSE | ||
|
||
[](https://drone.fsfe.org/reuse/reuse-spec) | ||
[](https://github.com/RichardLitt/standard-readme) | ||
[](https://reuse.software/) | ||
|
||
We're working to make managing copyrights and licenses in free and open | ||
source software easier. This is the website for a guide of best practices, | ||
meant to demonstrate how | ||
to add copyright and license information to a project in ways which allow | ||
for more automation. | ||
|
||
## Install | ||
|
||
There's no installation here, but you may try running `hugo` in the | ||
`site/` directory to generate the website when testing locally. | ||
Typically, we let our Drone CI build and deploy the website for us. | ||
|
||
## Usage | ||
|
||
Go to https://reuse.software/ and enjoy :-) If your project follows the reuse | ||
guidelines, we encourage you to show that in your `README.md` and similar! Just | ||
copy this badge into your readme: | ||
|
||
` | ||
[](https://reuse.software/) | ||
` | ||
|
||
## Contribute | ||
|
||
We'd love to get feedback on these practices, ideally in the form | ||
of pull requests which we can discuss around. To be able to contribute | ||
in this way, you need an account on `git.fsfe.org`, which you can | ||
get by going to our [account creation page](https://fsfe.org/fellowship/ams/index.php?ams=register). This will sign you up for a volunteer account with the FSFE. | ||
|
||
Once you've registered, your account needs to be activated. Just shoot a mail to <[email protected]> or directly to <[email protected]> saying you've registered and would like to be activated. As soon as your account is activated, you can set a username and proceed to login to `git.fsfe.org`. | ||
|
||
We also accept and appreciate feedback by creating issues in the project | ||
(requires the same account creation), or by sending e-mail to, again, | ||
<[email protected]> or <[email protected]>. | ||
|
||
## License | ||
|
||
The theme used for this website is based on [github-project-landing-page](https://github.com/nsomar/github-project-landing-page) which is licensed under the | ||
the [MIT license](https://github.com/nsomar/github-project-landing-page/blob/master/LICENSE.md). | ||
|
||
The content of the website, the best practices, are licensed under [Creative Commons Attribution-ShareAlike 4.0](https://creativecommons.org/licenses/by-sa/4.0). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
version: '3' | ||
services: | ||
reuse-spec: | ||
container_name: reuse-docs | ||
build: | ||
context: ./reuse-docs | ||
image: reuse-docs | ||
volumes: | ||
- /srv/reuse/docs/pdf:/home/user/pdf:rw | ||
|
||
reuse-web: | ||
container_name: reuse-web | ||
build: . | ||
image: reuse-web | ||
restart: always | ||
volumes: | ||
- /srv/reuse/docs/pdf:/tmp/pdf:ro | ||
environment: | ||
- VIRTUAL_HOST=reuse.software | ||
- LETSENCRYPT_HOST=reuse.software | ||
- [email protected] | ||
|
||
# Connect the container which exposes the service to the 'bridge' network as | ||
# this is where the reverse proxy is | ||
connect-bridge: | ||
image: docker:dind | ||
volumes: | ||
- /var/run/docker.sock:/var/run/docker.sock | ||
depends_on: | ||
- reuse-web | ||
command: /bin/sh -c 'docker network connect bridge reuse-web' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
baseurl = "https://reuse.software" | ||
languageCode = "en-us" | ||
title = "REUSE Initiative" | ||
theme = "github-project-landing-page" | ||
|
||
#[permalinks] | ||
# page = "/:title/" | ||
# about = "/:filename/" | ||
|
||
|
||
[params] | ||
description = "Best practices on adding license information in ways which not only humans can read, but computers as well. Machine readable copyright and license information, simply put!" | ||
|
||
first_color="#f8f8f8" | ||
first_border_color="#e7e7e7" | ||
first_text_color="#333" | ||
|
||
second_color="white" | ||
second_text_color="#333" | ||
|
||
header_color="#f8f8f8" | ||
header_text_color="rgb(51, 51, 51)" | ||
|
||
header_link_color="#777" | ||
header_link_hover_color="rgb(51, 51, 51)" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
title: "About REUSE" | ||
--- | ||
|
||
<div class="container header-container"> | ||
<div class="row"> | ||
<div class="col-md-1"></div> | ||
<div class="intro-image col-md-3"> | ||
<img src="/img/reuse.png" style="width: 60%; margin-top: 4em;"/> | ||
</div> | ||
<div class="intro-message col-md-6"> | ||
<p> | ||
We’re making managing copyrights and licenses in free and open source software easier. Our best practices are meant to demonstrate how to add copyright and license information to a project in ways which allow for more automation. We know you want to focus on coding, but there are a few simple steps to take to make the copyright and license of your project more easily understood. | ||
</p> | ||
<hr /> | ||
<center> | ||
<a class="btn btn-default" href="/practices/2.0/"> | ||
<i class="fa fa-book"></i> Read the practices</a> | ||
<a class="btn btn-default" href="/dev/"> | ||
<i class="fa fa-laptop"></i> View developer docs </a> | ||
</center> | ||
<hr /> | ||
The REUSE initiative is a project of the <a href="https://fsfe.org/">FSFE</a> | ||
and you're welcome to reach out to us on <a href="mailto:[email protected]">[email protected]</a>. Practices, related material and issues are also available in <a href="https://git.fsfe.org/reuse/">Git</a>. | ||
|
||
<center> | ||
<img src="/img/fsfe_logo.png" style="width: 60%; margin-top: 4em;"/> | ||
</center> | ||
</div> | ||
</div> | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
title: "REUSE For developers" | ||
--- | ||
<div class="intro-header"> | ||
|
||
<div class="container header-container"> | ||
<div class="row"> | ||
<div class="col-md-1"></div> | ||
<div class="intro-image col-md-3"> | ||
<img src="/img/reuse.png" style="width: 60%; margin-top: 4em;" /> | ||
<center> <div style="width: 100%;margin-top: 3em;"><p> | ||
</p> | ||
</div></center> | ||
</div> | ||
|
||
<div class="intro-message col-md-6"> | ||
<h3>Example repositories</h3> | ||
<p>These repositories are basic, but each of them is REUSE compliant. | ||
We make them available to demonstrate how REUSE works in practice.</p> | ||
<ul> | ||
<li><a href="https://git.fsfe.org/reuse/simple-hello">Simple Hello</a> - the most basic repository, a single source code file and license.</li> | ||
<li><a href="https://git.fsfe.org/reuse/included-hello">Included Hello</a> - a simple repository with included source code under a different license.</li> | ||
<li><a href="https://git.fsfe.org/reuse/spdx-hello">SPDX Hello</a> - a repository with Git commit hooks which automatically generate a bill of materials after each commit.</li> | ||
<li><a href="https://git.fsfe.org/jonas/curl/src/reuse-compliant">curl</a> - a repository which shows what a REUSE compliant curl repository would look like.</li> | ||
<li><a href="https://git.fsfe.org/reuse/reuse">reuse</a> - a repository that is compliant with itself.</li> | ||
</ul> | ||
|
||
<h3>Tools</h3> | ||
<ul> | ||
<li><a href="https://git.fsfe.org/reuse/reuse">reuse</a>, a linter tool to validate whether a repository is REUSE compliant or not, and a compiler tool to generate a project's bill of materials.</li> | ||
</ul> | ||
|
||
<h3>Documentation</h3> | ||
<p> | ||
Aside from the <a href="/practices/">practices</a>, we have some | ||
blog posts and similar documents which might be useful for you to | ||
understand how the REUSE practices work.. in practice. | ||
</p> | ||
<ul> | ||
<li><a href="http://blog.jonasoberg.net/a-reuse-compliant-curl/">REUSE curl</a>, a guide in making a mid sized project like curl REUSE compliant.</li> | ||
<li><a href="http://blog.jonasoberg.net/reuse-templates/">REUSE templates</a>, some information about our REUSE example repositories.</li> | ||
</ul> | ||
</div> | ||
</div> | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: "REUSE Materials" | ||
--- | ||
<div class="intro-header"> | ||
|
||
<div class="container header-container"> | ||
<div class="row"> | ||
<div class="col-md-1"></div> | ||
<div class="intro-image col-md-3"> | ||
<img src="/img/reuse.png" style="width: 60%; margin-top: 4em;" /> | ||
<center> <div style="width: 100%;margin-top: 3em;"><p> | ||
Feel free to use the material on this page as you see fit. Unless otherwise noted, the material is available under Creative Commons Attribution-ShareAlike 4.0. | ||
</p> | ||
</div></center> | ||
</div> | ||
|
||
<div class="intro-message col-md-6"> | ||
<h3>Graphical profile</h3> | ||
<p>The REUSE logotype in a few different formats is <a href="https://git.fsfe.org/reuse/reuse-ci/">available in Git</a></p> | ||
|
||
<h3>Badge</h3> | ||
<p><img src="/badge/reuse-compliant.svg" /></p> | ||
<p>Please use the URL <code>https://reuse.software/badge/reuse-compliant.svg</code> when linking to the badge!</p> | ||
<p>Use it like this:</p> | ||
<code> | ||
[](https://reuse.software/) | ||
</code> | ||
|
||
<h3>Presentations</h3> | ||
<p>We have a beginners introduction to REUSE, with speakers notes (<a href="/reuse/reuse-presentation.odp">ODP</a>, <a href="/reuse/reuse-presentation.pdf">PDF</a>). Do let us know if you use it somewhere, we'd love to know!</p> | ||
</div> | ||
</div> | ||
</div> | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
title: "REUSE For developers" | ||
--- | ||
<div class="intro-header"> | ||
|
||
<div class="container header-container"> | ||
<div class="row"> | ||
<div class="col-md-1"></div> | ||
<div class="intro-image col-md-3"> | ||
<img src="/img/reuse.png" style="width: 60%; margin-top: 4em;" /> | ||
<center> <div style="width: 100%;margin-top: 3em;"><p> | ||
</p> | ||
</div></center> | ||
</div> | ||
|
||
<div class="intro-message col-md-6"> | ||
<h3>Current version</h3> | ||
<ul> | ||
<li><a href="/practices/2.0/">2.0</a>, released 2017-12-14 | ||
</ul> | ||
|
||
<h3>Earlier versions</h3> | ||
<ul> | ||
<li><a href="/practices/1.2/">1.2</a>, released 2017-10-27 | ||
</ul> | ||
</div> | ||
</div> | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Privacy Policy | ||
## Who we are | ||
|
||
The *reuse.software* web site is run by the FSFE e.V. For information about FSFE, see <https://fsfe.org/about/legal/imprint.html>. | ||
|
||
When this policy refers to "we", this means FSFE. | ||
|
||
|
||
## What we collect and why | ||
When you use the website and sign up to receive information, we collect personal data which you have provided, with your consent. We do this so that we know who would like to receive information about us in the future. | ||
|
||
We store your email in a database for the duration of our work on this activity and remove it afterwards. | ||
|
||
## Who has access to stored data | ||
All information submitted through the website, whether stored on the webserver or in our issue system, is available to FSFE staff, interns and contractors. The information is also available to FSFE's system administrator team. Information is stored unencrypted on our servers, which means the information is also available to staff of PlusServer GmbH where our servers are hosted. | ||
|
||
## What your rights are | ||
You have the right to receive the personal data we have stored about you, as well as the right to instruct us to rectify it if it's incorrect. You also have the right to object to our storing of information, in which case we will remove personal data about you, and the right to remove your consent to processing of your personal data in line with this policy, in which case we will also take steps to remove personal data about you. | ||
|
||
## Who to contact | ||
If you have questions about our use of your data, would like to request a copy of all information we have stored about you, or would like to talk to our Data Protection Officer for any other purpose, our appointed Data Protection Officer is the FSFE's executive director, whom you can contact at <[email protected]>. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
+++ | ||
title = "REUSE" | ||
+++ | ||
|
||
# Just one step remaining.. | ||
|
||
Thank you for signing up to hear more about our work! There's just one | ||
step more. In a moment, we will be sending you an email to confirm we | ||
have the right address for you. Just click the link in that email, and | ||
we're good to go. | ||
|
||
Thanks for taking an interest in our work! | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
+++ | ||
title = "REUSE" | ||
+++ | ||
|
||
# Yay! We made it! | ||
|
||
We've gotten your address and made a note of it! We'll be in touch when | ||
we have something to share about our work on this project. | ||
|
Oops, something went wrong.