aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2023-09-04 14:14:09 -0300
committerSilvio Rhatto <rhatto@riseup.net>2023-09-04 14:14:09 -0300
commita8394fde06fab8ebcd28dd95de02441b98bd1f2c (patch)
tree3b8783fa948261069d44c06371354122e48dd266
parent3202d60391617674095d02b3c6c8e2c1210fb83d (diff)
downloadcopyfarai-a8394fde06fab8ebcd28dd95de02441b98bd1f2c.tar.gz
copyfarai-a8394fde06fab8ebcd28dd95de02441b98bd1f2c.tar.bz2
Feat: contributing
-rw-r--r--TODO.md44
-rw-r--r--docs/.pages2
-rw-r--r--docs/README.md2
-rw-r--r--docs/README.pt.md2
-rw-r--r--docs/contributing/.pages (renamed from docs/help/.pages)0
-rw-r--r--docs/contributing/README.md9
-rw-r--r--docs/contributing/README.pt.md10
-rw-r--r--docs/help/README.md1
-rw-r--r--docs/help/README.pt.md1
-rw-r--r--mkdocs.yml17
10 files changed, 38 insertions, 50 deletions
diff --git a/TODO.md b/TODO.md
deleted file mode 100644
index 4d6fb18..0000000
--- a/TODO.md
+++ /dev/null
@@ -1,44 +0,0 @@
-# TODO
-
-## Organization
-
-* [ ] Convert this TODO list into [tickets][].
-* [ ] Feedback on the received feedback.
-
-[tickets]: https://0xacab.org/copyfarai/copyfarai.itcouldbewor.se/-/issues
-
-## Licenses
-
-* [ ] Base text:
- * [ ] Specify other AI algorithms/methods (image classifiers etc).
-* [ ] Additional flavors:
- * [ ] Other Creative Commons variants.
- * [ ] Public domain.
- * [ ] Image rights.
-* [ ] Metadata:
- * [ ] Include a QR code and embed code so people can easily point to the license (like in photos and other contents).
- * [ ] Compact version (such as with Creative Commons).
- * [ ] Compact human readable version to use in places like profile information an e-mail footer signatures.
- * [ ] SPDX inclusion:
- * [International Open Standard (ISO/IEC 5962:2021) - Software Package Data Exchange (SPDX)](https://spdx.dev/)
- * [Software Package Data Exchange - Wikipedia](https://en.wikipedia.org/wiki/Software_Package_Data_Exchange)
- * [License Inclusion Principles - SPDX](https://github.com/spdx/license-list-XML/blob/main/DOCS/license-inclusion-principles.md)
- * [SPDX License List | Software Package Data Exchange (SPDX)](https://spdx.org/licenses/)
- * Similar licenses available:
- * [BSD 3-Clause No Military License | Software Package Data Exchange (SPDX)](https://spdx.org/licenses/BSD-3-Clause-No-Military-License.html)
- * [BSD 3-Clause No Nuclear License | Software Package Data Exchange (SPDX)](https://spdx.org/licenses/BSD-3-Clause-No-Nuclear-License.html)
-
-## Appearance
-
-* [ ] Color palette for the website.
-* [ ] Logo.
-
-## Participation
-
-* [ ] Include instructions on how to help.
-* [ ] Include a "seeking for maintainers" announcement.
-* [ ] Announce in:
- * [ ] Forums and other relevant places:
- * https://opensource.stackexchange.com/questions/13932/is-there-a-license-that-explicitly-exempts-ai-from-all-conditions
- * https://opensource.stackexchange.com/questions/13920/is-there-a-license-like-mit-that-explicitly-forbids-the-use-of-ai
- * https://wiki.p2pfoundation.net/Category:Licensing
diff --git a/docs/.pages b/docs/.pages
index c9443e1..944644c 100644
--- a/docs/.pages
+++ b/docs/.pages
@@ -5,5 +5,5 @@ nav:
- flavors
#- how
- references
- #- help
+ - contributing
- contact
diff --git a/docs/README.md b/docs/README.md
index d7ff7be..07c048a 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -5,7 +5,7 @@ Copy Far "AI" - A [copyleft][] license, but far from the so-called
[copyleft]: https://en.wikipedia.org/wiki/Copyleft
-## The license
+## The base license
Use and adapt this license as necessary:
diff --git a/docs/README.pt.md b/docs/README.pt.md
index 3ea0d10..f023036 100644
--- a/docs/README.pt.md
+++ b/docs/README.pt.md
@@ -5,7 +5,7 @@ Artificiais".
[copyleft]: https://pt.wikipedia.org/wiki/Copyleft
-## A licença
+## A licença base
Use esta licença e adapte-a conforme necessário:
diff --git a/docs/help/.pages b/docs/contributing/.pages
index fbd7cce..fbd7cce 100644
--- a/docs/help/.pages
+++ b/docs/contributing/.pages
diff --git a/docs/contributing/README.md b/docs/contributing/README.md
new file mode 100644
index 0000000..13f4073
--- /dev/null
+++ b/docs/contributing/README.md
@@ -0,0 +1,9 @@
+# Contributing
+
+How to help:
+
+* [x] Using the licenses!
+* [x] Promoting the project.
+* [x] Adopting or creating [tasks][], such as suggesting changes in the base license text.
+
+[tasks]: https://0xacab.org/copyfarai/copyfarai.itcouldbewor.se/-/issues
diff --git a/docs/contributing/README.pt.md b/docs/contributing/README.pt.md
new file mode 100644
index 0000000..4df6de2
--- /dev/null
+++ b/docs/contributing/README.pt.md
@@ -0,0 +1,10 @@
+# Contribuindo
+
+Como colaborar:
+
+* [x] Usando as licenças!
+* [x] Divulgando o projeto.
+* [x] Adotando ou criando [tarefas][], como por exemplo sugerindo mudanças no
+ texto base da licença.
+
+[tarefas]: https://0xacab.org/copyfarai/copyfarai.itcouldbewor.se/-/issues
diff --git a/docs/help/README.md b/docs/help/README.md
deleted file mode 100644
index e6b37b4..0000000
--- a/docs/help/README.md
+++ /dev/null
@@ -1 +0,0 @@
-# How to collaborate
diff --git a/docs/help/README.pt.md b/docs/help/README.pt.md
deleted file mode 100644
index fc7f4af..0000000
--- a/docs/help/README.pt.md
+++ /dev/null
@@ -1 +0,0 @@
-# Como colaborar
diff --git a/mkdocs.yml b/mkdocs.yml
index 8c46302..59c7490 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -7,13 +7,16 @@ docs_dir : docs
site_dir : public
dev_addr : '127.0.0.1:8070'
repo_url : https://0xacab.org/copyfarai/copyfarai.itcouldbewor.se
-edit_url : ''
+edit_uri: edit/main/docs/
# Site address is bind to 0.0.0.0 so it works find inside a Docker container.
# A better config would be desirable.
dev_addr : '0.0.0.0:8070'
theme:
+ #features:
+ # - content.action.edit
+
name : material
collapse_navigation: true
titles_only : false
@@ -63,8 +66,20 @@ plugins:
nav_translations:
Flavors: Sabores
+ # In case site structure is needed, this plugin will ensure permalink functionality
+ #- redirects:
+ # redirect_maps:
+ # 'flavors/CC-BY-NC-SA-4.0-FAI.en.md' : variants/CC-BY-NC-SA-4.0-FAI.en.md
+ # 'flavors/CC-BY-4.0-FAI.en.md' : variants/CC-BY-4.0-FAI.en.md
+ # 'flavors/CC-BY-4.0-FAI.pt.md' : variants/CC-BY-4.0-FAI.pt.md
+ # 'flavors/CC-BY-NC-SA-4.0-FAI.pt.md' : variants/CC-BY-NC-SA-4.0-FAI.pt.md
+ # 'flavors/CC-BY-SA-4.0-FAI.en.md' : variants/CC-BY-SA-4.0-FAI.en.md
+ # 'flavors/CC-BY-SA-4.0-FAI.pt.md' : variants/CC-BY-SA-4.0-FAI.pt.md
+
markdown_extensions:
- footnotes
+ - pymdownx.tasklist:
+ custom_checkbox: true
copyright: Copy Far "AI" &copy; 2023+