Skip to content

Commit

Permalink
Fixed #142 - Update link references of ownership from nexB to aboutco…
Browse files Browse the repository at this point in the history
…de-org

Signed-off-by: Chin Yeung Li <tli@nexb.com>
  • Loading branch information
chinyeungli committed Aug 21, 2024
1 parent 39bc8ba commit a9508b4
Show file tree
Hide file tree
Showing 11 changed files with 160 additions and 116 deletions.
15 changes: 7 additions & 8 deletions .github/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,19 @@

# Comment to be posted to on first time issues
newIssueWelcomeComment: |
Thanks for opening your first issue! 👍🎉😄⚡️
Do join our [Gitter channel](https://gitter.im/aboutcode-org/gsod-season-of-docs) for more discussions.
Thanks for opening your first issue! 👍🎉😄⚡️
Do join our [Gitter channel](https://gitter.im/aboutcode-org/gsod-season-of-docs) for more discussions.
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome

# Comment to be posted to on PRs from first time contributors in your repository
newPRWelcomeComment: |
Thanks for opening this pull request! 👍🎉😄⚡️
Also please refer [Contributing related documentation](https://aboutcode.readthedocs.io/en/latest/doc_maintenance.html) for more help! 💿
Thanks for opening this pull request! 👍🎉😄⚡️
Also please refer [Contributing related documentation](https://aboutcode.readthedocs.io/en/latest/doc_maintenance.html) for more help! 💿
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge

# Comment to be posted to on pull requests merged by a first time user
firstPRMergeComment: |
Congrats on merging your first pull request! 👍🎉😄⚡️
Now that you've completed this, you can help on more [Issues](https://github.com/nexB/aboutcode/issues)
Congrats on merging your first pull request! 👍🎉😄⚡️
Now that you've completed this, you can help on more [Issues](https://github.com/aboutcode-org/aboutcode/issues)
# It is recommend to include as many gifs and emojis as possible
22 changes: 20 additions & 2 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -1,19 +1,37 @@
#

# Copyright (c) nexB Inc. and others.

# SPDX-License-Identifier: Apache-2.0

#
# Visit https://aboutcode.org and https://github.com/nexB/ for support and download.

# Visit https://aboutcode.org and https://github.com/aboutcode-org/ for support and download.

# ScanCode is a trademark of nexB Inc.

#

# 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

# 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.

#
205 changes: 116 additions & 89 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,114 +4,141 @@

AboutCode is a family of FOSS projects to uncover data ... about software:

- where does the code come from? which software package?
- what is its license? copyright?
- is the code vulnerable, maintained, well coded?
- what are its dependencies, are there vulneribilities/licensing issues?

All these are questions that are important to answer: there are millions
of free and open source software components available on the web for reuse.

Knowing where a software package comes from, what its license is and whether it is
vulnerable should be a problem of the past such that everyone can safely consume
more free and open source software. We support not only open source software, but
also open data, generated and curated by our applications.

> **_NOTE:_** This is a repository with information on aboutcode open source activities and not
the actual code repository. See the [projects section](https://github.com/nexB/aboutcode#projects)
below for links to all the code repositories of our projects with a brief overview and our
[wiki](https://github.com/nexB/aboutcode/wiki) if you are looking to participate.
- where does the code come from? which software package?
- what is its license? copyright?
- is the code vulnerable, maintained, well coded?
- what are its dependencies, are there vulneribilities/licensing issues?

All these are questions that are important to answer: there are millions of free
and open source software components available on the web for reuse.

Knowing where a software package comes from, what its license is and whether it
is vulnerable should be a problem of the past such that everyone can safely
consume more free and open source software. We support not only open source
software, but also open data, generated and curated by our applications.

> **_NOTE:_** This is a repository with information on aboutcode open source
> activities and not the actual code repository. See the
> [projects section](https://github.com/aboutcode-org/aboutcode#projects) below
> for links to all the code repositories of our projects with a brief overview
> and our [wiki](https://github.com/aboutcode-org/aboutcode/wiki) if you are
> looking to participate.
### Documentation Build Status

![Doc Build](https://github.com/nexB/aboutcode/actions/workflows/docs-ci.yml/badge.svg)
![Doc Build](https://github.com/aboutcode-org/aboutcode/actions/workflows/docs-ci.yml/badge.svg)

### Important Links
### Important Links

Our homepage is at http://aboutcode.org

Our documentation (in progress) is at https://aboutcode.readthedocs.io/en/latest/
Our documentation (in progress) is at
https://aboutcode.readthedocs.io/en/latest/

Join the chat online at [app.gitter.im : aboutcode-org#discuss](https://app.gitter.im/#/room/#aboutcode-org_discuss:gitter.im)
or if you're using the element app set the homeserver to `gitter.im` and then join the [aboutcode-org#discuss](https://matrix.to/#/#aboutcode-org_discuss:gitter.im)
Join the chat online at
[app.gitter.im : aboutcode-org#discuss](https://app.gitter.im/#/room/#aboutcode-org_discuss:gitter.im)
or if you're using the element app set the homeserver to `gitter.im` and then
join the
[aboutcode-org#discuss](https://matrix.to/#/#aboutcode-org_discuss:gitter.im)
chatroom. Introduce yourself and start the discussion!

Look at our [wiki](https://github.com/nexB/aboutcode/wiki) for information about our participation
in the GSoC and GSoD programs.
Look at our [wiki](https://github.com/aboutcode-org/aboutcode/wiki) for
information about our participation in the GSoC and GSoD programs.

We have a weekly meeting, see more details [here](https://github.com/nexB/aboutcode/wiki/MeetingMinutes).
We have a weekly meeting, see more details
[here](https://github.com/aboutcode-org/aboutcode/wiki/MeetingMinutes).

### Projects

Each AboutCode project has its own repository:

- **[ScanCode Toolkit](https://github.com/nexB/scancode-toolkit)**: a set of code scanning tools to detect
the origin and license of code and dependencies. ScanCode now uses a plug-in architecture to run a series
of scan-related tools in one process flow. This is the most popular project and is used by 100's of software
teams . The lead maintainer is @pombredanne

- **[Scancode.io](https://github.com/nexB/scancode.io)**: is a web-based and API to run and review scans in
rich scripted pipelines, on different kinds of containers, docker images, package archives, manifests etc,
to get information on licenses, copyrights, source, vulneribilities. The lead maintainer is @tdruez

- **[VulnerableCode](https://github.com/nexB/vulnerablecode)**: is a web-based API and
database to collect and track all the known software package vulnerabilities, with
affected and fixed packages, references and a standalone tool Vulntotal to compare
this vulneribility information across similar tools. This is maintained by @tg1999 and @pombredanne

- **[univers](https://github.com/nexB/univers)** is a package to parse and compare
all the package versions and all the ranges.

- **[purlDB](https://github.com/nexB/purldb)** consists of tools to create and expose
a database of purls (Package URLs) and also has package data for all of these
packages created from scans. This is maintained by @jyang

- **[FetchCode](https://github.com/nexB/fetchcode)** is a library
to reliably fetch any code via HTTP, FTP and version control systems such as git.

- **[Scancode Workbench](https://github.com/nexB/scancode-workbench)**: a desktop application
based on typescript and react to visualize and review scan results from scancode scans.

- **[AboutCode Toolkit](https://github.com/nexB/aboutcode-toolkit)**: a set of command line tools to document
the provenance of your code and generate attribution notices. AboutCode Toolkit uses small yaml files to
document code provenance inside a codebase. The lead maintainer is @chinyeungli

- **[container-inspector](https://github.com/nexB/container-inspector)**: a tool to analyze the structure
and provenance of software components in Docker images using static analysis. Maintained by @pombredanne

- **[python-inspector](https://github.com/nexB/python-inspector)** and **[nuget inspector](https://github.com/nexB/nuget-inspector/)**
inspects manifests and code to resolve dependencies (vulnerable and non-vulnerable) for
python and nuget packages respectively.

- **[license-expression](https://github.com/nexB/license-expression/)**: a library to parse, analyze, compare
and normalize SPDX and SPDX-like license expressions using a boolean logic expression engine.
See https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60 to understand what an expression is.
See https://github.com/nexB/license-expression for the code. The underlying boolean engine is live at
https://github.com/bastikr/boolean.py . Both are co-maintained by @pombredanne

- **ABCD aka AboutCode Data**: a simple set of conventions to define data structures that all the
AboutCode tools can understand and use to exchange data. The details are at
[AboutCode Data](https://aboutcode.readthedocs.io/en/latest/aboutcode-data/abcd.html).
ABOUT files and ScanCode Toolkit data are examples of this approach. Other projects such as
https://libraries.io and and [OSS Review Toolkit](https://github.com/heremaps/oss-review-toolkit)
are also using these conventions.

- **[TraceCode Toolkit](https://github.com/nexB/tracecode-toolkit)**: a set of tools to trace files from your
deployment or distribution packages back to their origin in a development codebase or repository.
The primary tool uses strace https://github.com/strace/strace/ to trace system calls on Linux and construct
a build graph from syscalls to show which files are used to build a binary. We are contributors to strace.
Maintained by @pombredanne
- **[ScanCode Toolkit](https://github.com/aboutcode-org/scancode-toolkit)**: a
set of code scanning tools to detect the origin and license of code and
dependencies. ScanCode now uses a plug-in architecture to run a series of
scan-related tools in one process flow. This is the most popular project and
is used by 100's of software teams . The lead maintainer is @pombredanne

- **[Scancode.io](https://github.com/aboutcode-org/scancode.io)**: is a
web-based and API to run and review scans in rich scripted pipelines, on
different kinds of containers, docker images, package archives, manifests
etc, to get information on licenses, copyrights, source, vulneribilities.
The lead maintainer is @tdruez

- **[VulnerableCode](https://github.com/aboutcode-org/vulnerablecode)**: is a
web-based API and database to collect and track all the known software
package vulnerabilities, with affected and fixed packages, references and a
standalone tool Vulntotal to compare this vulneribility information across
similar tools. This is maintained by @tg1999 and @pombredanne

- **[univers](https://github.com/aboutcode-org/univers)** is a package to
parse and compare all the package versions and all the ranges.

- **[purlDB](https://github.com/aboutcode-org/purldb)** consists of tools to
create and expose a database of purls (Package URLs) and also has package
data for all of these packages created from scans. This is maintained by
@jyang

- **[FetchCode](https://github.com/aboutcode-org/fetchcode)** is a library to
reliably fetch any code via HTTP, FTP and version control systems such as
git.

- **[Scancode Workbench](https://github.com/aboutcode-org/scancode-workbench)**:
a desktop application based on typescript and react to visualize and review
scan results from scancode scans.

- **[AboutCode Toolkit](https://github.com/aboutcode-org/aboutcode-toolkit)**:
a set of command line tools to document the provenance of your code and
generate attribution notices. AboutCode Toolkit uses small yaml files to
document code provenance inside a codebase. The lead maintainer is
@chinyeungli

- **[container-inspector](https://github.com/aboutcode-org/container-inspector)**:
a tool to analyze the structure and provenance of software components in
Docker images using static analysis. Maintained by @pombredanne

- **[python-inspector](https://github.com/aboutcode-org/python-inspector)**
and **[nuget inspector](https://github.com/aboutcode-org/nuget-inspector/)**
inspects manifests and code to resolve dependencies (vulnerable and
non-vulnerable) for python and nuget packages respectively.

- **[license-expression](https://github.com/aboutcode-org/license-expression/)**:
a library to parse, analyze, compare and normalize SPDX and SPDX-like
license expressions using a boolean logic expression engine. See
https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60 to
understand what an expression is. See
https://github.com/aboutcode-org/license-expression for the code. The
underlying boolean engine is live at https://github.com/bastikr/boolean.py .
Both are co-maintained by @pombredanne

- **ABCD aka AboutCode Data**: a simple set of conventions to define data
structures that all the AboutCode tools can understand and use to exchange
data. The details are at
[AboutCode Data](https://aboutcode.readthedocs.io/en/latest/aboutcode-data/abcd.html).
ABOUT files and ScanCode Toolkit data are examples of this approach. Other
projects such as https://libraries.io and and
[OSS Review Toolkit](https://github.com/heremaps/oss-review-toolkit) are
also using these conventions.

- **[TraceCode Toolkit](https://github.com/aboutcode-org/tracecode-toolkit)**:
a set of tools to trace files from your deployment or distribution packages
back to their origin in a development codebase or repository. The primary
tool uses strace https://github.com/strace/strace/ to trace system calls on
Linux and construct a build graph from syscalls to show which files are used
to build a binary. We are contributors to strace. Maintained by @pombredanne

We also co-started and worked closely with other FOSS orgs and projects:

- [Package URL](https://github.com/package-url): a widely used standard to reference software packages of all types with simple,
readable and concise URLs.
- [Package URL](https://github.com/package-url): a widely used standard to
reference software packages of all types with simple, readable and concise
URLs.

- [SPDX](http://SPDX.org): aka. Software Package Data Exchange, a spec to document the origin and licensing of packages.
- [SPDX](http://SPDX.org): aka. Software Package Data Exchange, a spec to
document the origin and licensing of packages.

- [CycloneDX](https://cyclonedx.org) aka. OWASP CycloneDX is a full-stack
Bill of Materials (BOM) standard that provides advanced supply chain
capabilities for cyber risk reduction
- [CycloneDX](https://cyclonedx.org) aka. OWASP CycloneDX is a full-stack Bill
of Materials (BOM) standard that provides advanced supply chain capabilities
for cyber risk reduction

- [ClearlyDefined](https://ClearlyDefined.io): a project to review and help FOSS projects improve their licensing
and documentation clarity. This project is incubating with https://opensource.org
- [ClearlyDefined](https://ClearlyDefined.io): a project to review and help
FOSS projects improve their licensing and documentation clarity. This
project is incubating with https://opensource.org
2 changes: 1 addition & 1 deletion configure
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Copyright (c) nexB Inc. and others. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
# See https://github.com/nexB/ for support or download.
# See https://github.com/aboutcode-org/ for support or download.
# See https://aboutcode.org for more information about nexB OSS projects.
#

Expand Down
2 changes: 1 addition & 1 deletion configure.bat
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
@rem Copyright (c) nexB Inc. and others. All rights reserved.
@rem SPDX-License-Identifier: Apache-2.0
@rem See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
@rem See https://github.com/nexB/ for support or download.
@rem See https://github.com/aboutcode-org/ for support or download.
@rem See https://aboutcode.org for more information about nexB OSS projects.


Expand Down
Loading

0 comments on commit a9508b4

Please sign in to comment.