[VOL-5329] - Update copyright docs to mention SPDX
overview/contributing/copyright.rst
overview/contributing/copyright/Makefile.rst
overview/contributing/copyright/copyright.rst
overview/contributing/copyright/golang.rst
overview/contributing/copyright/json.rst
overview/contributing/copyright/markdown.rst
---------------------------------------------
o Add examples of copyright notice in source.
o json syntax most difficult to add.
o Document SPDX tokens.
o Creat a containing folder copyright/ so documentation setup can be modular.
conf.py
release_notes/voltha_2.12.rst
-----------------------------
o Sphinx replace:: feature stopped working, linkcheck reports broken urls.
o Move mvn-* and jira string templates into conf.py as ext links.
o Replace |token| with :token:.
o Also shorten several verbatim URLs with :vol-{ger,git}: extlinks.
Change-Id: I0f9ec3f4354044968805da1872fc9f6bd864996f
Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
diff --git a/overview/contributing/copyright.rst b/overview/contributing/copyright.rst
index 05ef2a2..6d9eae7 100644
--- a/overview/contributing/copyright.rst
+++ b/overview/contributing/copyright.rst
@@ -3,11 +3,34 @@
Include a copyright notice with all submissions to ONF repositoreis.
-- ``Copyright 2017-2023 Open Networking Foundation Contributors``
-- NOTE: Range values such as -present are not legally binding
+- Copyright 2017-2023 Open Networking Foundation Contributors
+ - NOTE: Range values such as -present are not legally binding
- Copyright notice should be dated to the last year sources were modified.
+.. code-block:: BASH
+ :caption: Project Copyright Notice
+
+ # -----------------------------------------------------------------------
+ # Copyright 2017-2024 Open Networking Foundation Contributors
+ #
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ # http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ # limitations under the License.
+ # -----------------------------------------------------------------------
+ # SPDX-FileCopyrightText: 2017-2024 Open Networking Foundation Contributors
+ # SPDX-License-Identifier: Apache-2.0
+ # -----------------------------------------------------------------------
+
+
See Also
--------
@@ -15,3 +38,5 @@
- `Message syntax <https://github.com/joey-onf/copyright/blob/origin/master/notice>`_
- `ONF CLA Information <https://wiki.opencord.org>`_
- `Contributing License Agreement Manager <https://cla.opennetworking.org/>`_
+
+`Copyrights <copyright/copyright>`_
diff --git a/overview/contributing/copyright/Makefile.rst b/overview/contributing/copyright/Makefile.rst
new file mode 100644
index 0000000..cb93667
--- /dev/null
+++ b/overview/contributing/copyright/Makefile.rst
@@ -0,0 +1,26 @@
+Copyright Notice: Makefile Syntax
+=================================
+
+.. code-block:: BASH
+ :caption: Makefile Syntax
+
+# -----------------------------------------------------------------------
+# Copyright 2017-2024 Open Networking Foundation Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# -----------------------------------------------------------------------
+# SPDX-FileCopyrightText: 2017-2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
+# Intent:
+# -----------------------------------------------------------------------
diff --git a/overview/contributing/copyright/copyright.rst b/overview/contributing/copyright/copyright.rst
new file mode 100644
index 0000000..13743b1
--- /dev/null
+++ b/overview/contributing/copyright/copyright.rst
@@ -0,0 +1,42 @@
+Copyright Notice
+================
+
+Include a copyright notice with all submissions to ONF repositoreis.
+
+- ``Copyright 2017-2023 Open Networking Foundation Contributors``
+- NOTE: Range values such as -present are not legally binding
+
+ - Copyright notice should be dated to the last year sources were modified.
+
+- Add SPDX tokens for programatic validation.
+
+.. toctree::
+ :maxdepth: 1
+ :hidden:
+ :caption: Copyright notice syntax
+
+ golang syntax <golang>
+ JSON <json>
+ Makefile <Makefile>
+ Markdown <markdown>
+
+License Validation: linting
+---------------------------
+
+- `REUSE Software <https://reuse.software/>`_
+- `The REUSE tool <https://git.fsfe.org/reuse/tool>`_
+- `pre-commit <https://pre-commit.com/>`_ hook `reuse-tool <https://github.com/fsfe/reuse-tool>`_
+
+See Also
+--------
+
+- `Copyright notices <https://github.com/joey-onf/copyright>`_
+- `Message syntax <https://github.com/joey-onf/copyright/blob/origin/master/notice>`_
+- `ONF CLA Information <https://wiki.opencord.org>`_
+- `Contributing License Agreement Manager <https://cla.opennetworking.org/>`_
+
+SPDX
+^^^^
+
+- `Handling license info <https://spdx.dev/learn/handling-license-info/>`_
+- `SPDX License List <https://spdx.org/licenses/>`_
diff --git a/overview/contributing/copyright/golang.rst b/overview/contributing/copyright/golang.rst
new file mode 100644
index 0000000..13ec153
--- /dev/null
+++ b/overview/contributing/copyright/golang.rst
@@ -0,0 +1,25 @@
+Copyright Notice: golang syntax
+===============================
+
+.. code-block:: GOLANG
+ :caption: Copyright Syntax
+
+ /* -----------------------------------------------------------------------
+ * Copyright 2017-2024 Open Networking Foundation Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * -----------------------------------------------------------------------
+ * SPDX-FileCopyrightText: 2017-2024 Open Networking Foundation Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ * -----------------------------------------------------------------------
+ */
diff --git a/overview/contributing/copyright/json.rst b/overview/contributing/copyright/json.rst
new file mode 100644
index 0000000..18b0776
--- /dev/null
+++ b/overview/contributing/copyright/json.rst
@@ -0,0 +1,16 @@
+Copyright Notice: Json syntax
+=============================
+
+.. code-block:: JSON
+ :caption: Copyright Syntax
+
+ {
+ {
+ "name": "sample-json-syntax",
+ "version": 1,
+ },
+ "copyright-notice" : {
+ "SPDX-FileCopyrightText" : "2024 Open Networking Foundation Contributors",
+ "SPDX-License-Identifier" : "Apache-2.0"
+ }
+ }
diff --git a/overview/contributing/copyright/markdown.rst b/overview/contributing/copyright/markdown.rst
new file mode 100644
index 0000000..e57068e
--- /dev/null
+++ b/overview/contributing/copyright/markdown.rst
@@ -0,0 +1,28 @@
+Copyright Notice: markdown syntax
+=================================
+
+.. code-block:: HTML
+ :caption: Markdown Syntax
+
+ <!--
+ # -----------------------------------------------------------------------
+ # Copyright 2017-2024 Open Networking Foundation Contributors
+ #
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ # http:#www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ # limitations under the License.
+ # -----------------------------------------------------------------------
+ # SPDX-FileCopyrightText: 2017-2024 Open Networking Foundation Contributors
+ # SPDX-License-Identifier: Apache-2.0
+ # -----------------------------------------------------------------------
+ # Intent:
+ # -----------------------------------------------------------------------
+ -->