Skip to content

Commit

Permalink
[GEOS-11134] Review generation of html files to double check NOTICE a…
Browse files Browse the repository at this point in the history 
…nd GPL included in licenses folder
  • Loading branch information
@jodygarnett
jodygarnett committed Oct 11, 2023
1 parent 716d389 commit 9d8ed33
Show file tree
Hide file tree
Showing 59 changed files with 1,196 additions and 598 deletions.
410 changes: 410 additions & 0 deletions LICENSE.md
View file

Large diffs are not rendered by default.

375 changes: 0 additions & 375 deletions LICENSE.txt
View file

This file was deleted.

2 changes: 1 addition & 1 deletion doc/en/developer/source/installer/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ However you can create your own installer (using a Windows machine).

unzip geoserver-[VERSION].zip

#. Copy the files :file:`LICENSE.txt`, :file:`src/release/GPL.txt` and the following files from :file:`src/release/installer/win` from the Geoserver source GeoServer package to the root of the unpacked archive (the same directory level as the :file:`start.jar`)::
#. Copy the files :file:`LICENSE.md`, :file:`src/release/licenses/GPL.md` and the following files from :file:`src/release/installer/win` from the Geoserver source GeoServer package to the root of the unpacked archive (the same directory level as the :file:`start.jar`)::

GeoServerEXE.nsi
gs.ico
Expand Down
4 changes: 2 additions & 2 deletions doc/en/developer/source/introduction.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ Question and answer:
License
-------

For complete license information review :download:`LICENSE.txt </../../../../LICENSE.txt>`.
For complete notice of license information :download:`LICENSE </../../../../licenses/NOTICE.md>`.

* GeoServer is free software and is licensed under the :download:`GNU General Public License </../../../../licenses/GPL.md>`::

GeoServer, open geospatial information server
Copyright (C) 2014 - Open Source Geospatial Foundation
Copyright (C) 2001 - 2014 OpenPlans
Expand Down
173 changes: 76 additions & 97 deletions doc/en/developer/source/policies/community-modules.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -270,111 +270,85 @@ Process

The next step is to include the new module in the release process.

*Core modules*

#. Edit ``release/src.xml`` and add an ``<include>`` for the module::

...
<moduleSets>
<moduleSet>
...
<include>org.geoserver:myCommunityModule</include>
</moduleSet>
</moduleSets>
...

*Extensions*

#. Create a new directory under ``release/extensions`` which matches the
name of the extension
#. Add the following to the new directory:

#. A license called '<module>-LICENSE.txt' which contains the license
for the extension
#. A readme called '<module>-README.txt' which contains instructions
on how to install the extension

#. A license called :file:`<module>-LICENSE.md` which contains the license notice
for the extension (linking to full `licenses/` documents included below).

Follow the :download:`h2-LICENSE.md </../../../../src/release/extensions/h2/h2-LICENSE.md>` example:

.. literalinclude:: /../../../../src/release/extensions/h2/h2-LICENSE.md
:language: Markdown

#. A readme called :file:`<module>-README.md` which contains instructions
on how to install the extension.

Follow the :download:`h2-README.md </../../../../src/release/extensions/h2/h2-README.md>` example:

.. literalinclude:: /../../../../src/release/extensions/h2/h2-README.md
:language: Markdown

.. warning::

Don't skip this step.

#. Any "static" files that are required by the extension (example
would be a proprietary driver not available for download via maven)

#. Create a release descriptor called 'ext-<module>.xml' under the
release directory which follows the following structure (where
"%module%" is the name of the module):

.. code-block:: xml
<assembly>
<id>%module%</id>
<formats>
<format>zip</format>
</formats>
<includeBaseDirectory>false</includeBaseDirectory>
<fileSets>
<fileSet>
<directory>release/extensions/%module%</directory>
<outputDirectory></outputDirectory>
<includes>
<include>*</include>
</includes>
</fileSet>
<fileSet>
<directory>release/target/dependency</directory>
<outputDirectory></outputDirectory>
<includes>
<include>%module%-*.jar</include>
</includes>
</fileSet>
<fileSet>
<directory>release/extensions</directory>
<outputDirectory></outputDirectory>
<includes>
<include>LICENSE.txt</include>
</includes>
</fileSet>
</fileSets>
</assembly>
* Add additional ``include`` elements in the second ``fileSet`` for
the jar dependencies of the module
* Add additional ``include`` elements in the third ``fileSet`` for
the static file dependencies of the module
Don't skip this step.

#. Any "static" files that are required by the extension.

An example would be data files or a proprietary driver not available for download via maven.

#. Create a release assembly called :file:`ext-<module>.xml` under the release directory.

Follow the example of :download:`ext-h2-xml </../../../../src/release/ext-h2.xml>`:

.. literalinclude:: /../../../../src/release/ext-h2.xml
:language: xml

* Add additional ``include`` elements in the root folder (outputDirectory empty) for
the jar dependencies of the module
* Add additional ``include`` elements in the licenses folder (outputDirectory ``licenses``) for
licenses required
* Add an additional fileSet if there are any static file dependencies of the module required by the module
* Use ``file`` with ``desName`` for any individual files that require renaming

#. Add a dependency from ``release/pom.xml`` to the extension
module::

<dependencies>
...
<dependency>
<groupId>org.geoserver.extension</groupId>
<artifactId>%module%</artifactId>
<version>%version%</version>
</dependency>
...
</dependencies>
module:

.. code-block:: xml
<dependencies>
...
<dependency>
<groupId>org.geoserver.extension</groupId>
<artifactId>%module%</artifactId>
<version>%version%</version>
</dependency>
...
</dependencies>
#. Add an entry for the release descriptor to the root ``pom.xml`` of
the source tree (i.e. one step up from the release directory)::

<!-- artifact assembly -->
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<version>2.1</version>
<configuration>
<descriptors>
<descriptor>release/src.xml</descriptor>
<descriptor>release/war.xml</descriptor>
<descriptor>release/javadoc.xml</descriptor>
<descriptor>release/bin.xml</descriptor>
<descriptor>release/doc.xml</descriptor>
...
<descriptor>release/ext-%module%.xml</descriptor>
</descriptors>
</configuration>
</plugin>
the source tree (i.e. one step up from the release directory):

.. code-block:: xml
<!-- artifact assembly -->
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<version>2.1</version>
<configuration>
<descriptors>
<descriptor>release/war.xml</descriptor>
<descriptor>release/javadoc.xml</descriptor>
<descriptor>release/bin.xml</descriptor>
<descriptor>release/doc.xml</descriptor>
...
<descriptor>release/ext-%module%.xml</descriptor>
</descriptors>
</configuration>
</plugin>
#. Update the documentation

Expand All @@ -384,11 +358,16 @@ Process

Finish this by linking somewhere...

#. Download the contributor agreement
#. Download and a contributor license agreement as pdf for txt file:

The final step in the process is to download and fill out the
`contributor agreement form <http://www.osgeo.org/sites/osgeo.org/files/Page/individual_contributor.txt>`_. Follow the instructions
on the form to submit it.
* `Individual Contributor License Agreement <https://www.osgeo.org/resources/individual-contributor-license/>`_

* `Software Grant and Corporate Contributor License Agreement <https://www.osgeo.org/resources/corporate-contributor-license/>`_

This option can also be used as a "software grant" to donate a specific named contribution in its entirety,
as was done for GeoFence, and indeed GeoServer itself.

#. Follow the instructions on the form to submit it.

Demoting a community module
---------------------------
Expand Down
7 changes: 4 additions & 3 deletions doc/en/user/source/introduction/license.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@
License
=======

For complete license details review :download:`LICENSE.txt </../../../../LICENSE.txt>`.
For complete license information :download:`NOTICE.txt </../../../../licenses/NOTICE.md>`.

GeoServer is free software and is licensed under the :download:`GNU General Public License </../../../../licenses/GPL.md>`:

.. literalinclude:: /../../../../LICENSE.txt
:lines: 3-37
.. include:: /../../../../LICENSE.md
:start-line: 3
:end-line: 37

This product includes software developed by the Apache Software Foundation (http://www.apache.org/) licensed under the :download:`Apache License Version 2.0 </../../../../licenses/apache-2.0.md>` and :download:`Apache License Version 1.1 </../../../../licenses/apache-1.1.md>`.

Expand Down
7 changes: 4 additions & 3 deletions doc/zhCN/user/source/introduction/license.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@
许可
=======

　　详细情况请下载 :download:`全文 </../../../../LICENSE.txt>` 阅读。
　　详细情况请下载 :download:`全文 </../../../../LICENSE.md>` 阅读。

　　GeoServer是 :download:`GNU通用性公开许可 </../../../../licenses/GPL.md>` 授权下的自由软件。

.. literalinclude:: /../../../../LICENSE.txt
:lines: 3-37
.. include:: /../../../../LICENSE.txt
:start-line: 3
:end-line: 37

　　该产品包含部分 :download:`Apache许可证2.0版 </../../../../licenses/apache-2.0.md>` 和 :download:`Apache许可证1.1版 </../../../../licenses/apache-1.1.md>` 授权下的，Apache软件基金会的软件。

Expand Down
2 changes: 1 addition & 1 deletion licenses/GEOTOOLS_NOTICE.txt
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GeoTools license notice
# GeoTools License Notice

The files in this library are part of GeoTools, an open source Java GIS
toolkit. See [geotools.org](https://geotools.org/) for details on the project.
Expand Down
2 changes: 1 addition & 1 deletion licenses/NOTICE.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GeoServer Notice
# GeoServer License Notice

GeoServer is distributed under the GNU General Public License Version 2.0 license:

Expand Down
Loading

0 comments on commit 9d8ed33

Please sign in to comment.