Skip to content

Commit

Permalink
Fixed #3885 - Update link references of ownership from nexB to aboutc…
Browse files Browse the repository at this point in the history
…ode-org

 - Only references under docs are updated.

Signed-off-by: Chin Yeung Li <[email protected]>
  • Loading branch information
chinyeungli committed Aug 9, 2024
1 parent 549d031 commit 07c2e71
Show file tree
Hide file tree
Showing 29 changed files with 133 additions and 133 deletions.
18 changes: 9 additions & 9 deletions docs/source/cli-reference/basic-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
"license_expression": "apache-2.0",
"rule_identifier": "apache-2.0_65.RULE",
"rule_relevance": 100,
"rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/apache-2.0_65.RULE",
"rule_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/rules/apache-2.0_65.RULE",
"matched_text": "License: Apache-2.0"
}
],
Expand Down Expand Up @@ -587,19 +587,19 @@

A scan example using the ``--license-url-template TEXT`` option ::

scancode -clpieu --json-pp output.json samples --license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}.LICENSE
scancode -clpieu --json-pp output.json samples --license-url-template https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}.LICENSE

In a normal scan, reference url for "ZLIB License" is as follows::

"reference_url": "https://scancode-licensedb.aboutcode.org/zlib",

After using the option in the following manner::

``--license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}.LICENSE``
``--license-url-template https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}.LICENSE``

the reference URL changes to this `zlib.LICENSE file <https://github.com/nexB/scancode-toolkit/blob/develop/src/licensedcode/data/licenses/zlib.LICENSE>`_::
the reference URL changes to this `zlib.LICENSE file <https://github.com/aboutcode-org/scancode-toolkit/blob/develop/src/licensedcode/data/licenses/zlib.LICENSE>`_::

"reference_url": "https://github.com/nexB/scancode-toolkit/blob/develop/src/licensedcode/data/licenses/zlib.LICENSE",
"reference_url": "https://github.com/aboutcode-org/scancode-toolkit/blob/develop/src/licensedcode/data/licenses/zlib.LICENSE",

The reference URL changes for all detected licenses in the scan, across the scan result file.

Expand Down Expand Up @@ -691,7 +691,7 @@
"license_expression": "unknown-license-reference",
"rule_identifier": "lead-in_unknown_30.RULE",
"rule_relevance": 100,
"rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/lead-in_unknown_30.RULE",
"rule_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/rules/lead-in_unknown_30.RULE",
"matched_text": "dual-licensed under [`
},
{
Expand All @@ -704,7 +704,7 @@
"license_expression": "wtfpl-2.0",
"rule_identifier": "spdx_license_id_wtfpl_for_wtfpl-2.0.RULE",
"rule_relevance": 50,
"rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/spdx_license_id_wtfpl_for_wtfpl-2.0.RULE",
"rule_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/rules/spdx_license_id_wtfpl_for_wtfpl-2.0.RULE",
"matched_text": "WTFPL"
},
{
Expand All @@ -717,7 +717,7 @@
"license_expression": "wtfpl-2.0",
"rule_identifier": "wtfpl-2.0_27.RULE",
"rule_relevance": 100,
"rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/wtfpl-2.0_27.RULE",
"rule_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/rules/wtfpl-2.0_27.RULE",
"matched_text": "www.wtfpl.net/"
},
{
Expand All @@ -730,7 +730,7 @@
"license_expression": "mit",
"rule_identifier": "mit_64.RULE",
"rule_relevance": 100,
"rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/mit_64.RULE",
"rule_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/rules/mit_64.RULE",
"matched_text": "MIT`](https://opensource.org/licenses/MIT)."
}
],
Expand Down
4 changes: 2 additions & 2 deletions docs/source/cli-reference/help-text-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ The Following Help Text is displayed, i.e. This is the help text for Scancode Ve
--csv FILE [DEPRECATED] Write scan output as CSV to FILE. The
--csv option is deprecated and will be replaced by new
CSV and tabular output formats in the next ScanCode
release. Visit https://github.com/nexB/scancode-
release. Visit https://github.com/aboutcode-org/scancode-
toolkit/issues/3043 to provide inputs and feedback.
--html FILE Write scan output as HTML to FILE.
--custom-output FILE Write scan output to FILE formatted with the custom
Expand Down Expand Up @@ -321,7 +321,7 @@ The Following Text is displayed, i.e. This is the available plugins for Scancode
required_plugins:
options:
help_group: output formats, name: csv: --csv
help: [DEPRECATED] Write scan output as CSV to FILE. The --csv option is deprecated and will be replaced by new CSV and tabular output formats in the next ScanCode release. Visit https://github.com/nexB/scancode-toolkit/issues/3043 to provide inputs and feedback.
help: [DEPRECATED] Write scan output as CSV to FILE. The --csv option is deprecated and will be replaced by new CSV and tabular output formats in the next ScanCode release. Visit https://github.com/aboutcode-org/scancode-toolkit/issues/3043 to provide inputs and feedback.
doc: None

--------------------------------------------
Expand Down
8 changes: 4 additions & 4 deletions docs/source/cli-reference/output-format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ following options.
"--package": true,
"--url": true
},
"notice": "Generated with ScanCode and provided on an \"AS IS\" BASIS, WITHOUT WARRANTIES\nOR CONDITIONS OF ANY KIND, either express or implied. No content created from\nScanCode should be considered or used as legal advice. Consult an Attorney\nfor any legal advice.\nScanCode is a free software code scanning tool from nexB Inc. and others.\nVisit https://github.com/nexB/scancode-toolkit/ for support and download.",
"notice": "Generated with ScanCode and provided on an \"AS IS\" BASIS, WITHOUT WARRANTIES\nOR CONDITIONS OF ANY KIND, either express or implied. No content created from\nScanCode should be considered or used as legal advice. Consult an Attorney\nfor any legal advice.\nScanCode is a free software code scanning tool from nexB Inc. and others.\nVisit https://github.com/aboutcode-org/scancode-toolkit/ for support and download.",
"start_timestamp": "2019-10-19T191117.292858",
"end_timestamp": "2019-10-19T191219.743133",
"message": null,
Expand Down Expand Up @@ -221,7 +221,7 @@ following options.

The whole Output file looks like::

{"headers":[{"tool_name":"scancode-toolkit","tool_version":"3.1.1","options":{"input":["samples/"],"--copyright":true,"--email":true,"--info":true,"--json-lines":"output.json","--license":true,"--package":true,"--url":true},"notice":"Generated with ScanCode and provided on an \"AS IS\" BASIS, WITHOUT WARRANTIES\nOR CONDITIONS OF ANY KIND, either express or implied. No content created from\nScanCode should be considered or used as legal advice. Consult an Attorney\nfor any legal advice.\nScanCode is a free software code scanning tool from nexB Inc. and others.\nVisit https://github.com/nexB/scancode-toolkit/ for support and download.","start_timestamp":"2019-10-19T210920.143831","end_timestamp":"2019-10-19T211052.048182","message":null,"errors":[],"extra_data":{"files_count":36}}]}
{"headers":[{"tool_name":"scancode-toolkit","tool_version":"3.1.1","options":{"input":["samples/"],"--copyright":true,"--email":true,"--info":true,"--json-lines":"output.json","--license":true,"--package":true,"--url":true},"notice":"Generated with ScanCode and provided on an \"AS IS\" BASIS, WITHOUT WARRANTIES\nOR CONDITIONS OF ANY KIND, either express or implied. No content created from\nScanCode should be considered or used as legal advice. Consult an Attorney\nfor any legal advice.\nScanCode is a free software code scanning tool from nexB Inc. and others.\nVisit https://github.com/aboutcode-org/scancode-toolkit/ for support and download.","start_timestamp":"2019-10-19T210920.143831","end_timestamp":"2019-10-19T211052.048182","message":null,"errors":[],"extra_data":{"files_count":36}}]}
{"files":[{"path":"samples" ... "scan_errors":[]}]}
{"files":[{"path":"samples/README", ... "scan_errors":[]}]}
{"files":[{"path":"samples/screenshot.png", ... "scan_errors":[]}]}
Expand Down Expand Up @@ -340,7 +340,7 @@ Comparing Different ``json`` Output Formats
ScanCode should be considered or used as legal advice. Consult an Attorney
for any legal advice.
ScanCode is a free software code scanning tool from nexB Inc. and others.
Visit https://github.com/nexB/scancode-toolkit/ for support and download.</text>
Visit https://github.com/aboutcode-org/scancode-toolkit/ for support and download.</text>


# Creation Info
Expand Down Expand Up @@ -459,7 +459,7 @@ Comparing Different ``json`` Output Formats

This option is deprecated and will be replaced by new CSV and tabular
output formats in the next ScanCode release. Visit
https://github.com/nexB/scancode-toolkit/issues/3043
https://github.com/aboutcode-org/scancode-toolkit/issues/3043
for details and to provide inputs and feedback.

The following code performs a scan on the samples directory, and publishes the results in
Expand Down
6 changes: 3 additions & 3 deletions docs/source/cli-reference/scan-options-post.rst
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ To see all plugins available via command line help, use ``--plugins``.
"ignorable_urls": [],
"ignorable_emails": [],
"text": "Permission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"scancode_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/mit.LICENSE",
"scancode_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/mit.LICENSE",
"licensedb_url": "https://scancode-licensedb.aboutcode.org/mit",
"spdx_url": "https://spdx.org/licenses/MIT"
}
Expand All @@ -419,7 +419,7 @@ To see all plugins available via command line help, use ``--plugins``.
"license_expression": "mit",
"identifier": "mit_30.RULE",
"language": "en",
"rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/mit_30.RULE",
"rule_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/rules/mit_30.RULE",
"is_license_text": false,
"is_license_notice": false,
"is_license_reference": false,
Expand Down Expand Up @@ -462,7 +462,7 @@ To see all plugins available via command line help, use ``--plugins``.
"license_expression": "mit",
"rule_identifier": "mit_30.RULE",
"rule_relevance": 100,
"rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/mit_30.RULE",
"rule_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/rules/mit_30.RULE",
"matched_text": "License: mit"
}
],
Expand Down
2 changes: 1 addition & 1 deletion docs/source/cli-reference/synopsis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ A sample JSON output file structure will look like::
"--package": true,
"--url": true
},
"notice": "Generated with ScanCode and provided on an \"AS IS\" BASIS, WITHOUT WARRANTIES\nOR CONDITIONS OF ANY KIND, either express or implied. No content created from\nScanCode should be considered or used as legal advice. Consult an Attorney\nfor any legal advice.\nScanCode is a free software code scanning tool from nexB Inc. and others.\nVisit https://github.com/nexB/scancode-toolkit/ for support and download.",
"notice": "Generated with ScanCode and provided on an \"AS IS\" BASIS, WITHOUT WARRANTIES\nOR CONDITIONS OF ANY KIND, either express or implied. No content created from\nScanCode should be considered or used as legal advice. Consult an Attorney\nfor any legal advice.\nScanCode is a free software code scanning tool from nexB Inc. and others.\nVisit https://github.com/aboutcode-org/scancode-toolkit/ for support and download.",
"start_timestamp": "2019-10-19T191117.292858",
"end_timestamp": "2019-10-19T191219.743133",
"message": null,
Expand Down
6 changes: 3 additions & 3 deletions docs/source/contribute/contrib_dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ TL;DR:
- We use DCO signoff in commit messages, like Linux does.
- Porting ScanCode to other OS (FreeBSD is supported, etc.) is possible. Enter an issue for help.

See `CONTRIBUTING.rst <https://github.com/nexB/scancode-toolkit/blob/develop/CONTRIBUTING.rst>`_
See `CONTRIBUTING.rst <https://github.com/aboutcode-org/scancode-toolkit/blob/develop/CONTRIBUTING.rst>`_
for details.


Expand Down Expand Up @@ -82,7 +82,7 @@ If you have a multiprocessor machine you might want to run the tests in parallel
typically run the tests in verbose mode with ``pytest -vvs -n4``.

You can also run a subset of the test suite as shown in the CI configs
https://github.com/nexB/scancode-toolkit/blob/develop/azure-pipelines.yml e,g,
https://github.com/aboutcode-org/scancode-toolkit/blob/develop/azure-pipelines.yml e,g,
``pytest -n 2 -vvs tests/scancode`` runs only the test scripts present in the
``tests/scancode`` directory. (You can give the path to a specific test script
file there too).
Expand Down Expand Up @@ -166,7 +166,7 @@ needing a compiler and toolchain to be installed.

The corresponding source code and build scripts for all for the
pre-built binaries are stored in a separate repository at
https://github.com/nexB/scancode-plugins
https://github.com/aboutcode-org/scancode-plugins

ScanCode app archives should not require network access for installation or
configuration of its third-party libraries and dependencies. To enable this,
Expand Down
8 changes: 4 additions & 4 deletions docs/source/contribute/contrib_doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To get started, create or identify a working directory on your local machine.

Open that directory and execute the following command in a terminal session::

git clone https://github.com/nexB/scancode-toolkit.git
git clone https://github.com/aboutcode-org/scancode-toolkit.git

That will create an ``/scancode-toolkit`` directory in your working directory.
Now you can install the dependencies in a virtualenv::
Expand Down Expand Up @@ -324,9 +324,9 @@ Automatic Docs Generation

It's possible to generate docs automatically from data by using a combination of:

- `shell scripts: example <https://github.com/nexB/scancode-toolkit/blob/develop/docs/scripts/regen_package_docs.sh>`_
- `python scripts: example <https://github.com/nexB/scancode-toolkit/blob/develop/src/packagedcode/regen_package_docs.py>`_
- `jinja templates: example <https://github.com/nexB/scancode-toolkit/blob/develop/src/packagedcode/templates/available_package_parsers.rst>`_
- `shell scripts: example <https://github.com/aboutcode-org/scancode-toolkit/blob/develop/docs/scripts/regen_package_docs.sh>`_
- `python scripts: example <https://github.com/aboutcode-org/scancode-toolkit/blob/develop/src/packagedcode/regen_package_docs.py>`_
- `jinja templates: example <https://github.com/aboutcode-org/scancode-toolkit/blob/develop/src/packagedcode/templates/available_package_parsers.rst>`_

And we do this currently to keep a documentation page for all the supported package formats.
See :ref:`supported_packages` for details.
2 changes: 1 addition & 1 deletion docs/source/contribute/cut_new_release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Tag and publish
Automated Release Process
-------------------------

- We have an `automated release script <https://github.com/nexB/scancode-toolkit/actions/workflows/scancode-release.yml>`_
- We have an `automated release script <https://github.com/aboutcode-org/scancode-toolkit/actions/workflows/scancode-release.yml>`_
triggered by a pushed tag, where jobs run to:

- Build pypi wheels and sdist archives
Expand Down
Loading

0 comments on commit 07c2e71

Please sign in to comment.