-In order to visit this link, you need to install mkdocs and mkdocs material theme in your system. After installing it, you need to add -Dhelp-docs=true flag in the maven command and build it again. -
diff --git a/frontend/sw360-portlet/src/documentation/mkdocs.yml b/frontend/sw360-portlet/src/documentation/mkdocs.yml deleted file mode 100644 index 19c4a1c677..0000000000 --- a/frontend/sw360-portlet/src/documentation/mkdocs.yml +++ /dev/null @@ -1,43 +0,0 @@ -# -# Copyright Siemens AG, 2021. Part of the SW360 Portal Project. -# -# This program and the accompanying materials are made -# available under the terms of the Eclipse Public License 2.0 -# which is available at https://www.eclipse.org/legal/epl-2.0/ -# -# SPDX-License-Identifier: EPL-2.0 -# - -site_name: SW360 Docs -docs_dir: 'sw360docs' - -theme: - name: 'material' - logo: 'img/logo.png' - -extra_css: - - stylesheets/extra.css - -use_directory_urls: false - -nav: -- Introduction: 'index.md' -- User Guide: - - 'Login to SW360' : 'user-guide/login/login.md' - - 'Components and Releases' : 'user-guide/component-and-releases/component-and-releases.md' - - 'Projects' : 'user-guide/projects/projects.md' - - 'Tasks for Experts' : 'user-guide/tasks-for-experts/tasks-for-experts.md' -- Administrator Guide: - - 'User Management Roles' : 'administrator-guide/user-management-roles/user-management-roles.md' - - 'Admin Menu' : 'administrator-guide/admin-menu/admin-menu.md' - - 'Properties' : 'administrator-guide/properties/properties.md' -- Best Practices: - - 'Component Naming' : 'sw360-best-practices/component-naming.md' - - 'License Naming' : 'sw360-best-practices/license-naming.md' - - 'Record Creation' : 'sw360-best-practices/good-record-creation-structure.md' - - 'SW360 Best Practices' : 'sw360-best-practices/sw360-best-practices.md' -- RESTful API: - - 'Introduction' : 'sw360-RESTful-API/introduction.md' - - 'Access' : 'sw360-RESTful-API/access.md' - - 'API Guide' : '/resource/docs/api-guide.html' -- FAQ: 'sw360-user-FAQ/sw360-user-FAQ.md' \ No newline at end of file diff --git a/frontend/sw360-portlet/src/documentation/sw360docs/administrator-guide/admin-menu/ImagesBasic/admin_menu.png b/frontend/sw360-portlet/src/documentation/sw360docs/administrator-guide/admin-menu/ImagesBasic/admin_menu.png deleted file mode 100755 index b67c905c80..0000000000 Binary files a/frontend/sw360-portlet/src/documentation/sw360docs/administrator-guide/admin-menu/ImagesBasic/admin_menu.png and /dev/null differ diff --git a/frontend/sw360-portlet/src/documentation/sw360docs/administrator-guide/admin-menu/admin-menu.md b/frontend/sw360-portlet/src/documentation/sw360docs/administrator-guide/admin-menu/admin-menu.md deleted file mode 100644 index b5e35cb8fc..0000000000 --- a/frontend/sw360-portlet/src/documentation/sw360docs/administrator-guide/admin-menu/admin-menu.md +++ /dev/null @@ -1,32 +0,0 @@ -[//]: # (Copyright Siemens AG, 2021. Part of the SW360 Portal Project) -[//]: # (This program and the accompanying materials are made) -[//]: # (available under the terms of the Eclipse Public License 2.0) -[//]: # (which is available at https://www.eclipse.org/legal/epl-2.0/) -[//]: # (SPDX-License-Identifier: EPL-2.0) - -# Admin Menu -------------------- - -The **admin menu** consists of the following items: - - - -- **User**: Displays the list of **Liferay Users**. One can also download or upload new users in this section - -- **Vendors**: Displays the list of the **Vendors** that can be managed by the admin - -- **Bulk License Edit**: List of licenses can be edited together in this section - -- **Licenses**: Functions such as Download License Archive, Upload License Archive, Import SPDX Information and Delete License Information can be done in this section - -- **Obligations**: To manage different types of Obligations on the basis of obligation level and obligation type - -- **Schedule**: To schedule tasks such as CVE Search - -- **Fosology**: Connection to the Fossology server - -- **Import and Export**: Can Import and Export **Component**, **Release** and **License** information - -- **Attachment Cleanup**: To cleanup attachment database - -- **Database Sanitization**: Helps in searching for duplicate identifiers \ No newline at end of file diff --git a/frontend/sw360-portlet/src/documentation/sw360docs/administrator-guide/properties/properties.md b/frontend/sw360-portlet/src/documentation/sw360docs/administrator-guide/properties/properties.md deleted file mode 100644 index 4b0316c8c3..0000000000 --- a/frontend/sw360-portlet/src/documentation/sw360docs/administrator-guide/properties/properties.md +++ /dev/null @@ -1,29 +0,0 @@ -[//]: # (Copyright Siemens AG, 2021. Part of the SW360 Portal Project) -[//]: # (This program and the accompanying materials are made) -[//]: # (available under the terms of the Eclipse Public License 2.0) -[//]: # (which is available at https://www.eclipse.org/legal/epl-2.0/) -[//]: # (SPDX-License-Identifier: EPL-2.0) - -# Properties ---------------------------- - -**Frontend Properties**: All the sw360 frontend properties are mentioned in [sw360.properties](https://github.com/eclipse/sw360/blob/master/frontend/sw360-portlet/src/main/resources/sw360.properties) file. -For example; - - - Different categories for components, - - component.categories=[ "framework", "SDK", "big-data", "build-management", "cloud", "content", "database", "graphics", "http", "javaee", "library", "mail", "mobile", "network-client", "network-server", "osgi", "security", "testing", "virtual-machine", "web-framework", "xml"] - - - Dropdown for project type, - - project.type=[ "Customer Project", "Internal Project", "Product", "Service", "Inner Source" ] - - - API Token generation, - - rest.apitoken.generator.enable=false - - - Activation of portlets and components - -**Backend Properties**: This, [sw360.properties](https://github.com/eclipse/sw360/blob/master/backend/src-common/src/main/resources/sw360.properties) file contains the sw360 backend properties. This file contains the common properties for the backend services and also holds the setting for the mail utility. - -You can change these default values by mentioning it in the sw360.properties file, present in /etc/sw360 folder. This path is to be created by the admin. After changing the properties, server needs to be restarted in order to make the changes effective. If the properties file is not present in the required folder, the default values will be selected. \ No newline at end of file diff --git a/frontend/sw360-portlet/src/documentation/sw360docs/administrator-guide/user-management-roles/user-management-roles.md b/frontend/sw360-portlet/src/documentation/sw360docs/administrator-guide/user-management-roles/user-management-roles.md deleted file mode 100644 index 1c17d56c7b..0000000000 --- a/frontend/sw360-portlet/src/documentation/sw360docs/administrator-guide/user-management-roles/user-management-roles.md +++ /dev/null @@ -1,38 +0,0 @@ -[//]: # (Copyright Siemens AG, 2021. Part of the SW360 Portal Project) -[//]: # (This program and the accompanying materials are made) -[//]: # (available under the terms of the Eclipse Public License 2.0) -[//]: # (which is available at https://www.eclipse.org/legal/epl-2.0/) -[//]: # (SPDX-License-Identifier: EPL-2.0) - -# User Management Roles -------------------- - -Every user can create records and edit own created records. However, to change records of others, approval is required. Approval in SW360 is a so called moderation request. A moderation request is a set of proposed changed not applied to record immediately, but will be routed to; - -- The creator of the record -- The moderators for a record -- The clearing admins of the same group in SW360. - -Then, the proposed changes can be approved by them. - -## General SW360 Roles and Access - -There are two main types of roles. The first type are general roles on the system that apply in the default case: - -1. **User** - A user is the default, in order to apply modifications, a user can pose moderation requests, except for the data items that a user has created. -2. **Clearing Expert** - Member of the clearing team. Has the rights to work on the projects of the own group and to edit licenses. Can also work on clearing requests. -3. **Clearing Admin** - A clearing admin has the rights to work on the projects of the own group and to edit licenses. -4. **ECC Admin** - The only users who can edit (or approve as moderation request) ECC classifications. -5. **Secuirty Admin** - The only users to edit relevance for security vulnerabilities. -6. **SW360 Admin** - An admin has full rights on all (visible!) data items. Can elevate permissions of other users. - -In addition there are ACL-style roles, meaning that per data item access settings can be made: - -1. **Creator** - A creator can modify in addition to the user's read abilities, a user can be creator of a data item. -2. **Moderator** - A creator can define moderators for a data item. Moderators can change a data item as a creator can. -3. **Contributor** (Component) - Is a contributor to a component, project, similar (but not the same) to a moderator. In addition to moderator, this role has been added to identify contributors (or that contributors get the fame). In contrast, the contributor cannot delete data items. -4. **Project Owner** - A user who owns the project. -5. **Lead Architect** (Project) - Is a contributor, just named differently to identify the responsible person. an architect refers to the person who has that role of the project or product. This role has been added to identify architects to have a contact person for technical questions. -6. **Project Responsible** (Project) - Is a contributor, just named differently to identify the responsible person. -7. **Security Responsible** - Users responsible for the security of the project. - diff --git a/frontend/sw360-portlet/src/documentation/sw360docs/img/logo.png b/frontend/sw360-portlet/src/documentation/sw360docs/img/logo.png deleted file mode 100644 index 5a3a4a653c..0000000000 Binary files a/frontend/sw360-portlet/src/documentation/sw360docs/img/logo.png and /dev/null differ diff --git a/frontend/sw360-portlet/src/documentation/sw360docs/index.md b/frontend/sw360-portlet/src/documentation/sw360docs/index.md deleted file mode 100644 index b979ab391f..0000000000 --- a/frontend/sw360-portlet/src/documentation/sw360docs/index.md +++ /dev/null @@ -1,71 +0,0 @@ -[//]: # (Copyright Siemens AG, 2021. Part of the SW360 Portal Project) -[//]: # (This program and the accompanying materials are made) -[//]: # (available under the terms of the Eclipse Public License 2.0) -[//]: # (which is available at https://www.eclipse.org/legal/epl-2.0/) -[//]: # (SPDX-License-Identifier: EPL-2.0) - -# SW360 Introduction --------------------- - -## Overview -**SW360** is a software catalogue application designed to provide a central place for sharing information about software components used by an organization. It is designed to neatly integrate into existing infrastructures related to the management of software artifacts and projects by providing separate backend services for distinct tasks and a set of portlets to access these services. A complete deployment unit exists (vagrant box or docker container) that contains a complete configuration of all services and portlets. - -SW360 comprises the following main use case areas: - -- Component: Handling of information and processes related to components, e.g. name, vendor -- License: Handling of information regarding licenses, e.g. obligations, license texts etc -- Project: handling of project information providing a context for the use of components -- Vulnerability: Collecting Security Vulnerability Management Information and matching them with components stored in the component service - -## Functionality -The SW360 is a software catalogue application which is: - -- Based on the Open Source Liferay portal server -- Integrated with Fossology - - With SW360, you can - -- Manage your components and projects -- Send source packages to the clearing tool Fossology -- Reuse cleared components and releases for your project -- Import cleared components with clearing reports and other documents -- Browse licenses and their obligations - -In order to work with SW360, please note a fundamental setup in the data model when dealing with components: - -- A component is a list of releases with metadata. vice versa, releases refer to a component. -- A vendor is separate from a component and releases. The link to the vendor is set at the release. (think of Sun and Oracle) -- A project refers to a number of releases of components accordingly, not components. - -The following picture outlines these decisions: - - - -## Important Links - -| Item | URL | Remark | -| --- | --- | --- | -| Public Project Homepage | [↗ https://www.eclipse.org/sw360/](https://www.eclipse.org/sw360/) | Main project homepage | -| Public Project GitHub Pages | [↗ https://github.com/eclipse/sw360/](https://github.com/eclipse/sw360/) | Main project | -| Project Project Information at Eclipse | [↗ https://projects.eclipse.org/projects/technology.sw360](https://projects.eclipse.org/projects/technology.sw360) | Some background info about Eclipse sw360 | -| Public Project Homepage SW360Antenna | [↗ https://github.com/eclipse/antenna](https://github.com/eclipse/antenna) | Antenna connects with sw360 to exchange information right from build time | -| Public Project sw360vagrant at GitHub | [↗ https://github.com/sw360/sw360vagrant](https://github.com/sw360/sw360vagrant) | Vagrant setup for sw360 | -| Public Project sw360chores at GitHub | [↗ https://github.com/sw360/sw360chores](https://github.com/sw360/sw360chores) | Docker setup for sw360 | -| Public Project sw360slides at GitHub | [↗ https://github.com/sw360/sw360slides](https://github.com/sw360/sw360slides) | Main slide deck of sw360 published as git repository | - - - - - - \ No newline at end of file diff --git a/frontend/sw360-portlet/src/documentation/sw360docs/stylesheets/extra.css b/frontend/sw360-portlet/src/documentation/sw360docs/stylesheets/extra.css deleted file mode 100644 index 8835c25fa5..0000000000 --- a/frontend/sw360-portlet/src/documentation/sw360docs/stylesheets/extra.css +++ /dev/null @@ -1,15 +0,0 @@ -/*! - * Copyright Siemens AG, 2020. Part of the SW360 Portal Project. - * - * This program and the accompanying materials are made - * available under the terms of the Eclipse Public License 2.0 - * which is available at https://www.eclipse.org/legal/epl-2.0/ - * - * SPDX-License-Identifier: EPL-2.0 -*/ -:root { - --md-primary-fg-color: #5d8ea9; - > * { - --md-footer-bg-color: #30313F; -} -} diff --git a/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/SW360RESTfulAPIImages/Preferences-AccessToke.png b/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/SW360RESTfulAPIImages/Preferences-AccessToke.png deleted file mode 100644 index fb9681de2d..0000000000 Binary files a/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/SW360RESTfulAPIImages/Preferences-AccessToke.png and /dev/null differ diff --git a/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/SW360RESTfulAPIImages/Preferences-AccessToke1.png b/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/SW360RESTfulAPIImages/Preferences-AccessToke1.png deleted file mode 100644 index cfeba2ac0f..0000000000 Binary files a/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/SW360RESTfulAPIImages/Preferences-AccessToke1.png and /dev/null differ diff --git a/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/SW360RESTfulAPIImages/techtokenreadexample.png b/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/SW360RESTfulAPIImages/techtokenreadexample.png deleted file mode 100644 index 6592b61fc0..0000000000 Binary files a/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/SW360RESTfulAPIImages/techtokenreadexample.png and /dev/null differ diff --git a/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/SW360RESTfulAPIImages/techtokenreadwriteexample.png b/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/SW360RESTfulAPIImages/techtokenreadwriteexample.png deleted file mode 100644 index f89343cd6b..0000000000 Binary files a/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/SW360RESTfulAPIImages/techtokenreadwriteexample.png and /dev/null differ diff --git a/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/access.md b/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/access.md deleted file mode 100644 index 9fea868a16..0000000000 --- a/frontend/sw360-portlet/src/documentation/sw360docs/sw360-RESTful-API/access.md +++ /dev/null @@ -1,145 +0,0 @@ -[//]: # (Copyright Siemens AG, 2021. Part of the SW360 Portal Project) -[//]: # (This program and the accompanying materials are made) -[//]: # (available under the terms of the Eclipse Public License 2.0) -[//]: # (which is available at https://www.eclipse.org/legal/epl-2.0/) -[//]: # (SPDX-License-Identifier: EPL-2.0) - -# RESTful API Access ------------------------ - -## How to get Access - -There are the following steps - -1. Open a browser with developer tools - -2. Go to - `https://