From aa565b5feeb8f46f1e696f225551a973c01d1fed Mon Sep 17 00:00:00 2001 From: Sukchan Lee Date: Tue, 15 Nov 2022 11:06:12 +0900 Subject: [PATCH] Update document --- docs/_config.yml | 2 + docs/_pages/about.md | 89 +----------------------------- docs/_pages/cla.md | 2 +- docs/_pages/oss-notice.md | 111 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 116 insertions(+), 88 deletions(-) create mode 100644 docs/_pages/oss-notice.md diff --git a/docs/_config.yml b/docs/_config.yml index 097cc773b..10d8bd0b0 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -59,6 +59,8 @@ footer_icons: header_pages: - _pages/docs.md - _pages/support.md + - _pages/cla.md + - _pages/oss-notice.md - _pages/about.md - _pages/github.md diff --git a/docs/_pages/about.md b/docs/_pages/about.md index e48ba7d4f..c72d26e55 100644 --- a/docs/_pages/about.md +++ b/docs/_pages/about.md @@ -6,7 +6,7 @@ permalink: /about/ Open5GS is a C-language Open Source implementation of 5GC and EPC, i.e. the core network of NR/LTE network. -### Supported Features +#### Supported Features --- - Release-16 compliant @@ -20,7 +20,7 @@ Open5GS is a C-language Open Source implementation of 5GC and EPC, i.e. the core - VoLTE(Voice over LTE) with HSS-Cx interface - VoNR(Voice over NR) -### Known Limitations +#### Known Limitations --- - No Interworking with EPC @@ -30,88 +30,3 @@ Open5GS is a C-language Open Source implementation of 5GC and EPC, i.e. the core - No SRVCC - No Roaming - No Emergency Call - - -### OSS Notice ---- - -The following sets forth attribution notices for third party software that may be contained in this repository. - -If you have any questions or concerns, please contact us at acetcom@gmail.com - ---- - -##### Apache Protable Runtime(ARP) -- [https://apr.apache.org/](https://apr.apache.org/) -- Copyright (C) The Apache Software Foundation -- LICENSE: [Apache-2.0](#apache-20) - -##### OpenSSL -- [https://www.openssl.org/](https://www.openssl.org/) -- Copyright (C) The OpenSSL Project Authors -- LICENSE: [Apache-2.0](#apache-20) - -##### GnuTLS -- [https://www.gnutls.org/](https://www.gnutls.org/) -- Copyright (C) Free Software Foundation, Inc. -- LICENSE: [LGPL-2.1-or-later](#lgpl-21-or-later) - -##### LIBGCRYPT -- [https://gnupg.org/software/libgcrypt/index.html](https://gnupg.org/software/libgcrypt/index.html) -- Copyright (C) The GnuPG Project -- LICENSE: [LGPL-2.1-or-later](#lgpl-21-or-later) - -##### Linux Kernel Stream Control Transmission Protocol Tools -- [https://lksctp.sourceforge.net/](https://lksctp.sourceforge.net/) -- Copyright 2002 La Monte H.P. Yarroll; Copyright 2002, 2004 IBM Corp.; Copyright 2010, 2013 Red Hat -- LICENSE: [LGPL-2.1-or-later](#lgpl-21-or-later) - -##### GNU IDN Library -- [https://www.gnu.org/software/libidn/](https://www.gnu.org/software/libidn/) -- Copyright (C) Free Software Foundation, Inc. -- LICENSE: [LGPL-2.1-or-later](#lgpl-21-or-later) - -##### libmongoc -- [https://mongoc.org/libmongoc/current/index.html](https://mongoc.org/libmongoc/current/index.html) -- Copyright 2017-present MongoDB, Inc. -- LICENSE: [Apache-2.0](#apache-20) - -##### libbson -- [http://mongoc.org/libbson/current/index.html](http://mongoc.org/libbson/current/index.html) -- Copyright 2017-present MongoDB, Inc. -- LICENSE: [Apache-2.0](#apache-20) - -##### LibYAML -- [https://pyyaml.org/wiki/LibYAML](https://pyyaml.org/wiki/LibYAML) -- Copyright (c) 2017-2020 Ingy döt Net Copyright (c) 2006-2016 Kirill Simonov -- License: [MIT](#mit) - -##### Nghttp2 -- [https://nghttp2.org/](https://nghttp2.org/) -- Copyright (C) 2022 - Tatsuhiro Tsujikawa -- License: [MIT](#mit) - -##### libcurl -- [https://curl.se/libcurl/](https://curl.se/libcurl/) -- Copyright (C) 2019 - 2022, Daniel Stenberg, , et al. -- License: [MIT](#mit) - -##### GNU Libmicrohttpd -- [https://www.gnu.org/software/libmicrohttpd/](https://www.gnu.org/software/libmicrohttpd/) -- Copyright (C) Free Software Foundation, Inc. -- LICENSE: [LGPL-2.1-or-later](#lgpl-21-or-later) - -##### libtins -- [http://libtins.github.io/](http://libtins.github.io/) -- Copyright (c) 2012-2017, Matias Fontanini -- License: [BSD-2-Clause](#bsd-2-clause) - -##### libtalloc -- [https://talloc.samba.org/talloc/doc/html/index.html](https://talloc.samba.org/talloc/doc/html/index.html) -- Copyright (C) Andrew Tridgell 2004-2005, Stefan Metzmacher 2006 -- LICENSE: [LGPL-2.1-or-later](#lgpl-21-or-later) - -##### usrsctp -- [https://github.com/sctplab/usrsctp](https://github.com/sctplab/usrsctp) -- Copyright (c) 2015, Randall Stewart and Michael Tuexen - - License: [BSD-3-Clause](#bsd-3-clause) diff --git a/docs/_pages/cla.md b/docs/_pages/cla.md index 8795fd05f..746ba996f 100644 --- a/docs/_pages/cla.md +++ b/docs/_pages/cla.md @@ -1,6 +1,6 @@ --- layout: page -title: Contributor License Agreement +title: CLA permalink: /cla/ --- diff --git a/docs/_pages/oss-notice.md b/docs/_pages/oss-notice.md new file mode 100644 index 000000000..7456a034d --- /dev/null +++ b/docs/_pages/oss-notice.md @@ -0,0 +1,111 @@ +--- +layout: page +title: OSS Notice +permalink: /oss-notice/ +--- + +The following sets forth attribution notices for third party software that may be contained in this repository. + +If you have any questions or concerns, please contact us at acetcom@gmail.com + +--- + +##### Apache Protable Runtime(ARP) +- [https://apr.apache.org/](https://apr.apache.org/) +- Copyright (C) The Apache Software Foundation +- LICENSE: [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) + +##### OpenSSL +- [https://www.openssl.org/](https://www.openssl.org/) +- Copyright (C) The OpenSSL Project Authors +- LICENSE: [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) + +##### GnuTLS +- [https://www.gnutls.org/](https://www.gnutls.org/) +- Copyright (C) Free Software Foundation, Inc. +- LICENSE: [LGPL-2.1-or-later](https://www.gnu.org/licenses/lgpl-3.0.html) + +##### LIBGCRYPT +- [https://gnupg.org/software/libgcrypt/index.html](https://gnupg.org/software/libgcrypt/index.html) +- Copyright (C) The GnuPG Project +- LICENSE: [LGPL-2.1-or-later](https://www.gnu.org/licenses/lgpl-3.0.html) + +##### GNU IDN Library +- [https://www.gnu.org/software/libidn/](https://www.gnu.org/software/libidn/) +- Copyright (C) Free Software Foundation, Inc. +- LICENSE: [LGPL-2.1-or-later](https://www.gnu.org/licenses/lgpl-3.0.html) + +##### FreeBSD-ipfw +- [https://github.com/freebsd/freebsd-src/tree/main/sbin/ipfw](https://github.com/freebsd/freebsd-src/tree/main/sbin/ipfw) +- Copyright 1992-2022 The FreeBSD Project +- License: [BSD-2-Clause](https://opensource.org/licenses/BSD-2-Clause) + +##### LibYAML +- [https://pyyaml.org/wiki/LibYAML](https://pyyaml.org/wiki/LibYAML) +- Copyright (c) 2017-2020 Ingy döt Net Copyright (c) 2006-2016 Kirill Simonov +- License: [MIT](https://opensource.org/licenses/mit-license.php) + +##### prometheus-client-c +- [https://github.com/digitalocean/prometheus-client-c](https://github.com/digitalocean/prometheus-client-c) +- Copyright (C) 2022 DigitalOcean, LLC. +- LICENSE: [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) + +##### Linux Kernel Stream Control Transmission Protocol Tools +- [https://lksctp.sourceforge.net/](https://lksctp.sourceforge.net/) +- Copyright 2002 La Monte H.P. Yarroll; Copyright 2002, 2004 IBM Corp.; Copyright 2010, 2013 Red Hat +- LICENSE: [LGPL-2.1-or-later](https://www.gnu.org/licenses/lgpl-3.0.html) + +##### libmongoc +- [https://mongoc.org/libmongoc/current/index.html](https://mongoc.org/libmongoc/current/index.html) +- Copyright 2017-present MongoDB, Inc. +- LICENSE: [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) + +##### libbson +- [http://mongoc.org/libbson/current/index.html](http://mongoc.org/libbson/current/index.html) +- Copyright 2017-present MongoDB, Inc. +- LICENSE: [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) + +##### freeDiameter +- [http://www.freediameter.net](http://www.freediameter.net) +- Copyright (c) 2008-2019, WIDE Project and NICT +- License: [BSD-2-Clause](https://opensource.org/licenses/BSD-2-Clause) + +##### asn1c +- [https://github.com/vlm/asn1c](https://github.com/vlm/asn1c) +- Copyright (c) Lev Walkin and contributors. +- License: [BSD-2-Clause](https://opensource.org/licenses/BSD-2-Clause) + +##### Nghttp2 +- [https://nghttp2.org/](https://nghttp2.org/) +- Copyright (C) 2022 - Tatsuhiro Tsujikawa +- License: [MIT](https://opensource.org/licenses/mit-license.php) + +##### libcurl +- [https://curl.se/libcurl/](https://curl.se/libcurl/) +- Copyright (C) 2019 - 2022, Daniel Stenberg, , et al. +- License: [MIT](https://opensource.org/licenses/mit-license.php) + +##### GNU Libmicrohttpd +- [https://www.gnu.org/software/libmicrohttpd/](https://www.gnu.org/software/libmicrohttpd/) +- Copyright (C) Free Software Foundation, Inc. +- LICENSE: [LGPL-2.1-or-later](https://www.gnu.org/licenses/lgpl-3.0.html) + +##### OpenAPI Generator +- [https://openapi-generator.tech/](https://openapi-generator.tech/) +- Copyright OpenAPI-Generator Contributors +- LICENSE: [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) + +##### libtins +- [http://libtins.github.io/](http://libtins.github.io/) +- Copyright (c) 2012-2017, Matias Fontanini +- License: [BSD-2-Clause](https://opensource.org/licenses/BSD-2-Clause) + +##### libtalloc +- [https://talloc.samba.org/talloc/doc/html/index.html](https://talloc.samba.org/talloc/doc/html/index.html) +- Copyright (C) Andrew Tridgell 2004-2005, Stefan Metzmacher 2006 +- LICENSE: [LGPL-2.1-or-later](https://www.gnu.org/licenses/lgpl-3.0.html) + +##### usrsctp +- [https://github.com/sctplab/usrsctp](https://github.com/sctplab/usrsctp) +- Copyright (c) 2015, Randall Stewart and Michael Tuexen + - License: [BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause)