From 753dee2013db0893e7daaf312a770d77b9ac4460 Mon Sep 17 00:00:00 2001
From: Martyn Welch <martyn.welch@collabora.com>
Date: Thu, 28 May 2020 20:09:36 +0100
Subject: [PATCH] Move policy documentation to a new "policies" section
Start organising the documents on the website. Move documents that are
concerned with Apertis policies (one way or another) into a "policies"
section and link to this from the main page.
Signed-off-by: Martyn Welch <martyn.welch@collabora.com>
---
config.toml | 12 ++---
content/_index.md | 4 +-
.../presentations.md} | 31 +------------
content/enabling_new_hardware.md | 2 +-
content/{ => policies}/about_apertis.md | 8 ++--
content/{ => policies}/code_of_conduct.md | 0
content/{ => policies}/community.md | 2 +-
content/{ => policies}/copyrights.md | 30 ++++++-------
content/{ => policies}/general_disclaimer.md | 0
.../hardware_enablement.md} | 4 +-
content/policies/marketing_resources.md | 44 +++++++++++++++++++
content/{ => policies}/privacy_policy.md | 0
content/{ => policies}/releases.md | 0
content/{ => policies}/upstream_first.md | 0
14 files changed, 75 insertions(+), 62 deletions(-)
rename content/{marketing_resources.md => docs/presentations.md} (50%)
rename content/{ => policies}/about_apertis.md (82%)
rename content/{ => policies}/code_of_conduct.md (100%)
rename content/{ => policies}/community.md (93%)
rename content/{ => policies}/copyrights.md (79%)
rename content/{ => policies}/general_disclaimer.md (100%)
rename content/{hardware_interfaces.md => policies/hardware_enablement.md} (99%)
create mode 100644 content/policies/marketing_resources.md
rename content/{ => policies}/privacy_policy.md (100%)
rename content/{ => policies}/releases.md (100%)
rename content/{ => policies}/upstream_first.md (100%)
diff --git a/config.toml b/config.toml
index f9b04e853..91d98e26b 100644
--- a/config.toml
+++ b/config.toml
@@ -31,7 +31,7 @@ languageCode = "en-us"
[menu]
# Header
[[menu.main]]
- url = "community/"
+ url = "policies/community/"
name = "Community"
weight = 1
[[menu.main]]
@@ -45,23 +45,23 @@ languageCode = "en-us"
# Footer
[[menu.footer]]
- url = "copyrights/"
+ url = "policies/copyrights/"
name = "Copyright Statement"
weight = 1
[[menu.footer]]
- url = "about_apertis/"
+ url = "policies/about_apertis/"
name = "About Apertis"
weight = 2
[[menu.footer]]
- url = "privacy_policy/"
+ url = "policies/privacy_policy/"
name = "Privacy Policy"
weight = 3
[[menu.footer]]
- url = "general_disclaimer/"
+ url = "policies/general_disclaimer/"
name = "Disclaimer"
weight = 4
[[menu.footer]]
- url = "code_of_conduct/"
+ url = "policies/code_of_conduct/"
name = "Code of Conduct"
weight = 5
diff --git a/content/_index.md b/content/_index.md
index ce70fe01d..54f2c02ca 100644
--- a/content/_index.md
+++ b/content/_index.md
@@ -33,7 +33,7 @@ Apertis undergoes regular [automated and manual testing](https://qa.apertis.org)
## Further Links
-* [Licensing](https://designs.apertis.org/latest/license-expectations.html)
+* [Policy Documentation]( {{< ref "policies" >}} )
* [Quality Assurance]( {{< ref "/qa/_index.md" >}} )
* [Test results](https://lavaphabbridge.apertis.org)
@@ -52,7 +52,7 @@ For more information, see [Release flow and product lines](https://designs.apert
* Current stable release: [v2020.0]( {{< ref "/release/v2020.0/releasenotes.md" >}} )
* Current old stable release: [v2019.2]( {{< ref "/release/v2019.2/releasenotes.md" >}} )
* Current development release: [v2021dev1]( {{< ref "/release/v2021dev1/releasenotes.md" >}} )
-* [Further Releases]( {{< ref "/releases.md" >}} )
+* [Further Releases]( {{< ref "releases.md" >}} )
# Developer Ready
diff --git a/content/marketing_resources.md b/content/docs/presentations.md
similarity index 50%
rename from content/marketing_resources.md
rename to content/docs/presentations.md
index 6dcd80564..0d10d377e 100644
--- a/content/marketing_resources.md
+++ b/content/docs/presentations.md
@@ -2,38 +2,9 @@
date = "2017-05-11"
weight = 100
-title = "Marketing resources"
-
-aliases = [
- "/old-wiki/Marketing_resources"
-]
+title = "Presentations"
+++
-## Apertis key visual
-
-The Apertis key visuals can be used to represent Apertis. Use them on
-slides and when talking about Apertis.
-
-These key visuals are copyright Collabora Ltd and licensed under
-[BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/).
-
-Visual with the words "Apertis":
-
-
-
- - 
- - 
- - 
-
-Visual without text:
-
-
-
- - 
- - 
-
-## Slides and presentations
-
These are some of the slides and presentations which members of the
Apertis community have previously shared (ordered newest to oldest):
diff --git a/content/enabling_new_hardware.md b/content/enabling_new_hardware.md
index 7efe65829..319132565 100644
--- a/content/enabling_new_hardware.md
+++ b/content/enabling_new_hardware.md
@@ -52,7 +52,7 @@ packages and package update will be required (e.g. kernel, bootloader,
firmware, graphics stack).
For more information about the requirements with respect to hardware
-enabling see the [Hardware Interfaces]( {{< ref "/hardware_interfaces.md" >}} )
+enabling see the [Hardware Enablement]( {{< ref "hardware_enablement.md" >}} )
page.
Once the hardware support is available in packages and accepted in the
diff --git a/content/about_apertis.md b/content/policies/about_apertis.md
similarity index 82%
rename from content/about_apertis.md
rename to content/policies/about_apertis.md
index 0d79ad3b0..45c52b3e7 100644
--- a/content/about_apertis.md
+++ b/content/policies/about_apertis.md
@@ -13,9 +13,9 @@ Apertis is a
[FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software)
([Free](https://en.wikipedia.org/wiki/Free_software) and [open
source](https://en.wikipedia.org/wiki/Open-source_software)) GNU/Linux-based
-platform for infotainment in automotive vehicles. It is a distribution
-derived from Debian/Ubuntu and geared towards the creation of
-product-specific images for ARM and Intel x86 systems.
+platform tailored to the automotive needs and fit for a wide variety of
+electronic devices. It is a distribution derived from Debian/Ubuntu and geared
+towards the creation of product-specific images for ARM and Intel x86 systems.
Apertis comes with a range of built-in features, which can be expanded
upon with custom applications that are available through an App Store.
@@ -33,7 +33,7 @@ Apertis is primarily licensed under the [Mozilla Public License
Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/), with images and
documentation licensed under [CC
BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/legalcode).
-You can find more information about the licensing for each repository in
+Individual You can find more information about the licensing for each repository in
the `COPYING` files in each repository.
Apertis also makes use of other projects such as the Linux kernel,
diff --git a/content/code_of_conduct.md b/content/policies/code_of_conduct.md
similarity index 100%
rename from content/code_of_conduct.md
rename to content/policies/code_of_conduct.md
diff --git a/content/community.md b/content/policies/community.md
similarity index 93%
rename from content/community.md
rename to content/policies/community.md
index 0dd85ef82..f70bf32dc 100644
--- a/content/community.md
+++ b/content/policies/community.md
@@ -25,4 +25,4 @@ The best ways to get in touch with the community are through:
contact *listmaster at apertis.org*
Remember that all contributors to Apertis are expected to [treat others
-with respect]( {{< ref "/code_of_conduct.md" >}} ).
+with respect]( {{< ref "code_of_conduct.md" >}} ).
diff --git a/content/copyrights.md b/content/policies/copyrights.md
similarity index 79%
rename from content/copyrights.md
rename to content/policies/copyrights.md
index d503fdb33..c39278f86 100644
--- a/content/copyrights.md
+++ b/content/policies/copyrights.md
@@ -9,29 +9,29 @@ aliases = [
]
+++
-The text of the Apertis wiki is copyrighted (automatically, under the
+The text of the Apertis website is copyrighted (automatically, under the
Berne Convention) by Apertis editors and contributors and is formally
-licensed under Creative Commons Attribution-ShareAlike 3.0 Unported
+licensed under Creative Commons Attribution-ShareAlike 4.0 Unported
License (CC BY-SA) unless explicitly stated otherwise.
-The licenses that the Apertis wiki uses grant free access to our content
-in the same sense that free software is licensed freely. Apertis wiki
+The licenses that the Apertis website uses grant free access to our content
+in the same sense that free software is licensed freely. Apertis website
content can be copied, modified, and redistributed *if and only if* the
copied version is made available on the same terms to others and
-acknowledgment of the authors of the Apertis wiki article used is
+acknowledgment of the authors of the Apertis website article used is
included (a link back to the article is generally thought to satisfy the
attribution requirement; see below for more details). Copied Apertis
-wiki content will therefore remain *free* under appropriate license and
+website content will therefore remain *free* under appropriate license and
can continue to be used by anyone subject to certain restrictions, most
of which aim to ensure that freedom. This principle is known as
**copyleft** in contrast to typical copyright licenses.
The English text of the CC BY-SA license is the only legally binding
-restriction between authors and users of the Apertis wiki content.
+restriction between authors and users of the Apertis website content.
## Contributors' rights and obligations
-If you contribute text directly to the Apertis wiki, you thereby license
+If you contribute text directly to the Apertis website, you thereby license
it to the public for reuse under CC BY-SA. Non-text media may be
contributed under a variety of different licenses that support the
general goal of allowing unrestricted re-use and re-distribution.
@@ -40,7 +40,7 @@ If you want to import text that you have found elsewhere or that you
have co-authored with others, you can only do so if it is available
under terms that are compatible with the CC BY-SA license.
-You retain copyright to materials you contribute to the Apertis wiki,
+You retain copyright to materials you contribute to the Apertis website,
text and media. Copyright is *never* transferred to Apertis. You can
later republish and relicense them in any way you like. However, you can
never retract or alter the license for copies of materials that you
@@ -57,7 +57,7 @@ license on their behalf.
### Re-use of text
- - Attribution: To re-distribute text from the Apertis wiki in any
+ - Attribution: To re-distribute text from the Apertis website in any
form, provide credit to the authors either by including a) a
hyperlink (where possible) or URL to the page or pages you are
re-using, b) a hyperlink (where possible) or URL to an alternative,
@@ -68,23 +68,23 @@ license on their behalf.
or irrelevant contributions.)
Copyleft/Share Alike: If you make modifications or additions to the
page you re-use, you must license them under the Creative Commons
- Attribution-Share-Alike License 3.0 or later.
+ Attribution-Share-Alike License 4.0 or later.
Indicate changes: If you make modifications or additions, you must
indicate in a reasonable fashion that the original work has been
- modified. If you are re-using the page in a wiki, for example,
+ modified. If you are re-using the page in a website, for example,
indicating this in the page history is sufficient.
Licensing notice: Each copy or modified version that you distribute
must include a licensing notice stating that the work is released
under CC BY-SA and either a) a hyperlink or URL to the text of the
license or b) a copy of the license. For this purpose, a suitable
- URL is: <http://creativecommons.org/licenses/by-sa/3.0/>
+ URL is: <http://creativecommons.org/licenses/by-sa/4.0/>
**For further information**, please refer to the [legal code of the CC
-BY-SA License](http://creativecommons.org/licenses/by-sa/3.0/legalcode).
+BY-SA License](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
## Notes
-This page applies only to the Apertis wiki. The Apertis code is licensed
+This page applies only to the Apertis website. The Apertis code is licensed
separately and the licenses can be found in the code repositories,
normally in a file called COPYING.
diff --git a/content/general_disclaimer.md b/content/policies/general_disclaimer.md
similarity index 100%
rename from content/general_disclaimer.md
rename to content/policies/general_disclaimer.md
diff --git a/content/hardware_interfaces.md b/content/policies/hardware_enablement.md
similarity index 99%
rename from content/hardware_interfaces.md
rename to content/policies/hardware_enablement.md
index 113b8a0f2..d825e5d83 100644
--- a/content/hardware_interfaces.md
+++ b/content/policies/hardware_enablement.md
@@ -2,7 +2,7 @@
date = "2019-12-03"
weight = 100
-title = "Hardware Interfaces"
+title = "Hardware Enablement"
aliases = [
"/hardware_interface.md",
@@ -36,8 +36,6 @@ improving). However even in that case, the components should be freely
distributable (such that Apertis images can be distributed with them)
and use standard APIs.
-# Hardware Enablement
-
The following sections highlight for different types of hardware what
software interface should be provided to enable it. As the list is not
exhaustive with respect to all available types of hardware (e.g. new
diff --git a/content/policies/marketing_resources.md b/content/policies/marketing_resources.md
new file mode 100644
index 000000000..6f785ebf2
--- /dev/null
+++ b/content/policies/marketing_resources.md
@@ -0,0 +1,44 @@
++++
+date = "2017-05-11"
+weight = 100
+
+title = "Marketing Resources"
+
+aliases = [
+ "/old-wiki/Marketing_resources"
+]
++++
+
+# The Apertis Logo
+
+The Apertis logo consists of 2 elements:
+
+1. The Symbol
+2. The Wordmark
+
+In most situations the Symbol and the Workmark should remain connected and
+used as a whole. In isolated cases, where suitable, it is permitted that
+the Symbol can be separated from the Workmark, likewise the Wordmark can
+be removed from the Symbol.
+
+When using the Symbol and Wordmark togther, please ensure that you
+maintain the spacing /layout between them as below.
+
+The Apertis logo are copyright Collabora Ltd and licensed under
+[BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/).
+
+The logo can be used to represent Apertis. Use them on slides and when
+talking about Apertis.
+
+## Symbol and Wordmark
+
+| PNG (100x100px) | PNG (500x500px) | SVG |
+| --------------- | --------------- | --- |
+|  |  |  |
+
+## Symbol
+
+| PNG (100x100px) | PNG (500x500px) |
+| -------------------------------- | -------------------------------- |
+|  |  |
+
diff --git a/content/privacy_policy.md b/content/policies/privacy_policy.md
similarity index 100%
rename from content/privacy_policy.md
rename to content/policies/privacy_policy.md
diff --git a/content/releases.md b/content/policies/releases.md
similarity index 100%
rename from content/releases.md
rename to content/policies/releases.md
diff --git a/content/upstream_first.md b/content/policies/upstream_first.md
similarity index 100%
rename from content/upstream_first.md
rename to content/policies/upstream_first.md
--
GitLab