This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
start [2016/05/24 21:26] Michael Jaeger [User Documentation] |
start [2019/01/08 15:59] Michael Jaeger [Google Summer of Code] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Fossology Documentation ====== | + | ====== Fossology Documentation ====== === Advancing open source license compliance === FOSSology is an open source license compliance software system and toolkit. As a toolkit you can run license, copyright and export control scans from the command line. As a system, a database and web ui are provided to give you a compliance workflow. In one click you can generate an SPDX file, or a ReadMe with the copyrights notices from your software. FOSSology deduplication means that you can scan an entire distro, submit a new version, and only the changed files will get rescanned. This is a big time saver for large projects. Please note: FOSSology does not give legal advice. |
- | === Advancing open source license compliance === | + | |
- | + | ||
- | FOSSology is an open source license compliance software system and toolkit. As a toolkit you can run license, copyright and export control scans from the command line. As a system, a database and web ui are provided to give you a compliance workflow. In one click you can generate an SPDX file, or a ReadMe with the copyrights notices from your software. FOSSology deduplication means that you can scan an entire distro, submit a new version, and only the changed files will get rescanned. This is a big time saver for large projects. | + | |
- | + | ||
- | Please note: FOSSology does not give legal advice. | + | |
==== Introduction ==== | ==== Introduction ==== | ||
- | Please see the [[Contact_Us|Contact Us page]] to subscribe to our mailing lists and/or join our irc channel. If you register you can also use the Forum on fossology.org. | + | Please see the [[https://www.fossology.org/about/contact|Contact Us]] page to subscribe to our mailing lists and/or join our irc channel. If you register you can also use the Forum on fossology.org. |
Our source repository, developer documentation and issue tracker are on https://github.com/fossology/fossology | Our source repository, developer documentation and issue tracker are on https://github.com/fossology/fossology | ||
Want to try out FOSSology? Try our demo server: | Want to try out FOSSology? Try our demo server: | ||
- | http://52.26.97.143/repo/ | + | |
+ | http://83.169.21.23/fossology/ | ||
(user: testuser, password: test, this is a user w/o admin rights) | (user: testuser, password: test, this is a user w/o admin rights) | ||
Line 27: | Line 23: | ||
==== User Documentation ==== | ==== User Documentation ==== | ||
- | A basic user documentation is on the projects home page. Please find here more detailed topcis documentation. //(to be completed)// | + | A basic user documentation is on the projects home page. Please find here more detailed topcis documentation (work in progress): |
+ | |||
+ | * [[FAQ|Frequently Asked Questions]]: Collected from user questions in e-mails and the mailing lists | ||
+ | |||
+ | * [[handson|Supplemental page for the Hands-On training]] | ||
==== Admin Documentation ==== | ==== Admin Documentation ==== | ||
- | FOSSology runs as a server application. As such, some topics require further documentation: | + | FOSSology runs as a server application. As such, some topics require further documentation: //(to be completed)// |
==== Developer Documentation ==== | ==== Developer Documentation ==== | ||
Line 39: | Line 40: | ||
The following lists pages from earlier versions of FOSSology: | The following lists pages from earlier versions of FOSSology: | ||
+ | |||
+ | //(to be completed)// | ||
==== Testing ==== | ==== Testing ==== | ||
The testing of FOSSology has two main areas: | The testing of FOSSology has two main areas: | ||
- | * Build/in software tests that can be executed during development and are also executed by the CI, such as travis or by a jenkins instance. | + | * Build/in software tests that can be executed during development and are also executed by the CI, such as travis or by a jenkins instance. See the [[Testing Overview]] for more details. |
* An [[System Testing|system testing documentation]] that is checked for every new release of FOSSology | * An [[System Testing|system testing documentation]] that is checked for every new release of FOSSology | ||
+ | |||
+ | ==== Project Internals ==== | ||
+ | |||
+ | Information about the infrastructure: [[infrastructure:start|Infrastructure]]. | ||
+ | |||
+ | ==== Google Summer of Code ==== | ||
+ | |||
+ | For the application of the FOSSology project we have created a wiki page for introduction of the topics and the application [[gsoc-2018]]. | ||
+ |