diff --git a/docs/source/cli-reference/basic-options.rst b/docs/source/cli-reference/basic-options.rst index 19240944b75..92ac1fa04d7 100644 --- a/docs/source/cli-reference/basic-options.rst +++ b/docs/source/cli-reference/basic-options.rst @@ -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" } ], @@ -587,7 +587,7 @@ 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:: @@ -595,11 +595,11 @@ 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 `_:: + the reference URL changes to this `zlib.LICENSE file `_:: - "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. @@ -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 [` }, { @@ -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" }, { @@ -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/" }, { @@ -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)." } ], diff --git a/docs/source/cli-reference/help-text-options.rst b/docs/source/cli-reference/help-text-options.rst index 58a4d6d8711..5e7a7694601 100644 --- a/docs/source/cli-reference/help-text-options.rst +++ b/docs/source/cli-reference/help-text-options.rst @@ -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 @@ -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 -------------------------------------------- diff --git a/docs/source/cli-reference/output-format.rst b/docs/source/cli-reference/output-format.rst index 4e4c67aff9c..ebc20396f92 100644 --- a/docs/source/cli-reference/output-format.rst +++ b/docs/source/cli-reference/output-format.rst @@ -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, @@ -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":[]}]} @@ -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. + Visit https://github.com/aboutcode-org/scancode-toolkit/ for support and download. # Creation Info @@ -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 diff --git a/docs/source/cli-reference/scan-options-post.rst b/docs/source/cli-reference/scan-options-post.rst index ccd21dd0644..01d305433af 100644 --- a/docs/source/cli-reference/scan-options-post.rst +++ b/docs/source/cli-reference/scan-options-post.rst @@ -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" } @@ -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, @@ -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" } ], diff --git a/docs/source/cli-reference/synopsis.rst b/docs/source/cli-reference/synopsis.rst index 16226d8e419..0e322bf0f1a 100644 --- a/docs/source/cli-reference/synopsis.rst +++ b/docs/source/cli-reference/synopsis.rst @@ -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, diff --git a/docs/source/contribute/contrib_dev.rst b/docs/source/contribute/contrib_dev.rst index 9a6c5ef49e9..af9b010e5dd 100644 --- a/docs/source/contribute/contrib_dev.rst +++ b/docs/source/contribute/contrib_dev.rst @@ -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 `_ +See `CONTRIBUTING.rst `_ for details. @@ -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). @@ -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, diff --git a/docs/source/contribute/contrib_doc.rst b/docs/source/contribute/contrib_doc.rst index 530f159b9f4..085c0d3c25e 100644 --- a/docs/source/contribute/contrib_doc.rst +++ b/docs/source/contribute/contrib_doc.rst @@ -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:: @@ -324,9 +324,9 @@ Automatic Docs Generation It's possible to generate docs automatically from data by using a combination of: -- `shell scripts: example `_ -- `python scripts: example `_ -- `jinja templates: example `_ +- `shell scripts: example `_ +- `python scripts: example `_ +- `jinja templates: example `_ And we do this currently to keep a documentation page for all the supported package formats. See :ref:`supported_packages` for details. diff --git a/docs/source/contribute/cut_new_release.rst b/docs/source/contribute/cut_new_release.rst index 2b47450983a..77b57f95a74 100644 --- a/docs/source/contribute/cut_new_release.rst +++ b/docs/source/contribute/cut_new_release.rst @@ -41,7 +41,7 @@ Tag and publish Automated Release Process ------------------------- -- We have an `automated release script `_ +- We have an `automated release script `_ triggered by a pushed tag, where jobs run to: - Build pypi wheels and sdist archives diff --git a/docs/source/contribute/gsoc17_final_report.rst b/docs/source/contribute/gsoc17_final_report.rst index 8dec03b8bd0..b237c857dd6 100644 --- a/docs/source/contribute/gsoc17_final_report.rst +++ b/docs/source/contribute/gsoc17_final_report.rst @@ -9,10 +9,10 @@ Yash D. Saraf `yashdsaraf@gmail.com `_ ---- This project’s purpose was to create a decoupled plugin architecture for -`ScanCode `_ such that it can handle plugins at different +`ScanCode `_ such that it can handle plugins at different stages of a scan and can be coupled at runtime. These stages were, -1. `Format `_ : +1. `Format `_ : --------------------------------------------------------------------- In this stage, the plugins are supposed to run **after** the scanning is done and ``post-scan`` @@ -35,7 +35,7 @@ format : ``' = :'``. The ```` name will be automatically added to the ``--format`` command line option and (if called) the scanned data will be passed to the plugin. -2. `Post-scan `_ : +2. `Post-scan `_ : ------------------------------------------------------------------------ In this stage, the plugins are supposed to run **after** the scanning is done. Some uses for these @@ -67,7 +67,7 @@ format ``' = :'`` The command line option for this plugin will be automatically created using the ```` 's doctring as its help text and (if called) the scanned files will be passed to the plugin. -3. `Pre-scan `_ : +3. `Pre-scan `_ : ----------------------------------------------------------------------- In this stage, the plugins are supposed to run **before** the scan starts. So the potential uses @@ -110,14 +110,14 @@ No development has been done for this stage, but it will be quite similar to ``p 5. Other work: -------------- -`Group cli options in cli help `_ +`Group cli options in cli help `_ Here, the goal was to add command line options to pre-defined groups such that they are displayed in their respective groups when ``scancode -h`` or ``scancode --help`` is called. This helped to better visually represent the command line options and determine more easily what context they belong to. -`Add a Resource class to hold all scanned info `_ +`Add a Resource class to hold all scanned info `_ * ``Ongoing`` * Here, the goal was to create a ``Resource`` class, such that it holds all the scanned data for a @@ -132,4 +132,4 @@ logic entirely. For now, it just holds the ``info`` and ``path`` of a resource. - More complex post-scan plugins - Support plugins written in languages other than python -**Additionally, all my commits can be found** `here `_. +**Additionally, all my commits can be found** `here `_. diff --git a/docs/source/contribute/gsoc19_final_report.rst b/docs/source/contribute/gsoc19_final_report.rst index c51473583e7..5468258454f 100644 --- a/docs/source/contribute/gsoc19_final_report.rst +++ b/docs/source/contribute/gsoc19_final_report.rst @@ -13,7 +13,7 @@ Overview **Problem:** Since Python 2.7 will retire in few months and will not be maintained any longer. -**Solution:** `Scancode `__ needs to be ported to +**Solution:** `Scancode `__ needs to be ported to python 3 and all test suites must pass on both version of Python. The main difference that makes Python 3 better than Python 2.x is that the support for unicode is greatly improved in Python 3. This will also be useful for scancode as scancode has users in more than 100 languages @@ -77,7 +77,7 @@ We came with various Solution: We choose the third solution because it is most fundamental and simple and easy to use. -Project was tracked in this ticket `nexB/scancode-toolkit#295 `__ +Project was tracked in this ticket `nexB/scancode-toolkit#295 `__ **Project link :** `Port Scancode to Python 3 `__ @@ -85,9 +85,9 @@ Project was tracked in this ticket `nexB/scancode-toolkit#295 `__ +**My contribution :** `List of Commits `__ -**Note :** Please give your feedback `here `_ +**Note :** Please give your feedback `here `_ Outcome ------- diff --git a/docs/source/contribute/gsoc21_final_report.rst b/docs/source/contribute/gsoc21_final_report.rst index 2d4da89dd64..c3836b27e5d 100644 --- a/docs/source/contribute/gsoc21_final_report.rst +++ b/docs/source/contribute/gsoc21_final_report.rst @@ -13,7 +13,7 @@ Akanksha Garg Project: Detect Unknown Licenses and Indirect License References in Scancode ----------------------------------------------------------------------------- -`ScanCode-toolkit `_ +`ScanCode-toolkit `_ `Project Link `_ @@ -37,7 +37,7 @@ to identify them beyond just the naming convention of having "unknown" as part o Rules that match at least one unknown license have a flag **"has_unknown"** set in the returned match results. -`nexB/scancode-toolkit#2548 `_ +`nexB/scancode-toolkit#2548 `_ **Reporting known and Unknown licenses separately** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -46,7 +46,7 @@ We considered having a separate section for of scan results to report 'unknown l separately and not mixed with main license detection results. But after implementing a separate section for unknown ones ,it doesn't seem to be good idea to have currently. -`nexB/scancode-toolkit#2578 `_ +`nexB/scancode-toolkit#2578 `_ **Follow License References to another file** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -59,11 +59,11 @@ Since this was a ``process_codebase`` step in scan plugin , it was needed that o should return ``refrenced_filenames`` to keep track of these files corresponding to licenses detected. This was tracked in - -`nexB/scancode-toolkit#2632 `_ +`nexB/scancode-toolkit#2632 `_ The ```process_codebase``` step is tracked in - -`nexB/scancode-toolkit#2616 `_ +`nexB/scancode-toolkit#2616 `_ **Improve license detection of Unknown Licenses** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -73,7 +73,7 @@ detection of "unknown" license rules. Firstly matches were filtered after runnin procedure of license detection and the remaining spans are run through a automaton index containing n-grams from all regular license texts and rules. This is tracked in - -`nexB/scancode-toolkit#2592 `_ +`nexB/scancode-toolkit#2592 `_ **Addition of some new Licenses** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -81,7 +81,7 @@ containing n-grams from all regular license texts and rules. This is tracked in There were some licenses that were not present in Scancode-toolkit as for now. They have been added now. -`nexB/scancode-toolkit#2625 `_ +`nexB/scancode-toolkit#2625 `_ Pre-GSoC @@ -89,10 +89,10 @@ Pre-GSoC **Contributions** -- `nexB/scancode-toolkit#2423 `_ -- `nexB/scancode-toolkit#2473 `_ -- `nexB/scancode-toolkit#2464 `_ -- `nexB/scancode-toolkit#2381 `_ +- `nexB/scancode-toolkit#2423 `_ +- `nexB/scancode-toolkit#2473 `_ +- `nexB/scancode-toolkit#2464 `_ +- `nexB/scancode-toolkit#2381 `_ I’ve had a wonderful summer during these 10 weeks journey and have learned plenty of things. I am thankful to Google and Aboutcode for giving me this opportunity to work with such an amazing diff --git a/docs/source/contribute/roadmap.rst b/docs/source/contribute/roadmap.rst index f97b8e7f81c..c66dc989a06 100644 --- a/docs/source/contribute/roadmap.rst +++ b/docs/source/contribute/roadmap.rst @@ -10,7 +10,7 @@ This is a high level list of what we are working on and what is completed. .. _note: - This is not updated regularly, see the `milestones `_ + This is not updated regularly, see the `milestones `_ instead for updated shorter and longer term roadmaps. Legend @@ -27,9 +27,9 @@ Package manifest and dependency parsers ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - |clock1030| Docker image base (as part of: https://github.com/pombredanne/conan ) #651 -- |clock1030| RubyGems base and dependencies #650 (code in https://github.com/nexB/scancode-toolkit-contrib/ ) -- |clock1030| Perl, CPAN (basic in https://github.com/nexB/scancode-toolkit-contrib/) -- |clock1030| Go : parsing for Godep in https://github.com/nexB/scancode-toolkit-contrib/ +- |clock1030| RubyGems base and dependencies #650 (code in https://github.com/aboutcode-org/scancode-toolkit-contrib/ ) +- |clock1030| Perl, CPAN (basic in https://github.com/aboutcode-org/scancode-toolkit-contrib/) +- |clock1030| Go : parsing for Godep in https://github.com/aboutcode-org/scancode-toolkit-contrib/ - |clock1030| Windows PE #652 - |white_large_square| RPM dependencies #649 - |white_large_square| Windows Nuget dependencies #648 @@ -45,7 +45,7 @@ Package manifest and dependency parsers License Detection ^^^^^^^^^^^^^^^^^ -- |white_check_mark| support and detect license expressions (code in https://github.com/nexB/license-expression) +- |white_check_mark| support and detect license expressions (code in https://github.com/aboutcode-org/license-expression) - |clock1030| support and detect composite licenses - |white_check_mark| support custom licenses - |white_large_square| move licenses data set to external separate repository @@ -88,16 +88,16 @@ Classification, summarization and deduction Source code support (some will be spawned as their own tool) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- |clock1030| symbols : parsing complete in https://github.com/nexB/scancode-toolkit-contrib/ -- |clock1030| metrics : some elements in https://github.com/nexB/scancode-toolkit-contrib/ +- |clock1030| symbols : parsing complete in https://github.com/aboutcode-org/scancode-toolkit-contrib/ +- |clock1030| metrics : some elements in https://github.com/aboutcode-org/scancode-toolkit-contrib/ Compiled code support (will be spawned as their own tool) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- |clock1030| ELFs : parsing complete in https://github.com/nexB/scancode-toolkit-contrib/ -- |clock1030| Java bytecode : parsing complete in https://github.com/nexB/scancode-toolkit-contrib/ -- |clock1030| Windows PE : parsing complete in https://github.com/nexB/scancode-toolkit-contrib/ -- |clock1030| Mach-O : parsing complete in in https://github.com/nexB/scancode-toolkit-contrib/ +- |clock1030| ELFs : parsing complete in https://github.com/aboutcode-org/scancode-toolkit-contrib/ +- |clock1030| Java bytecode : parsing complete in https://github.com/aboutcode-org/scancode-toolkit-contrib/ +- |clock1030| Windows PE : parsing complete in https://github.com/aboutcode-org/scancode-toolkit-contrib/ +- |clock1030| Mach-O : parsing complete in in https://github.com/aboutcode-org/scancode-toolkit-contrib/ - |white_large_square| Dalvik/dex Data exchange @@ -133,9 +133,9 @@ Other work in progress - |clock1030| ScanCode server: Separate project: https://github.com/nexB/scancode-server. Will include Integration / webhooks for Github, Bitbucket. - |clock1030| VulnerableCode: NVD and CVE lookups: Separate project: - https://github.com/nexB/vulnerablecode + https://github.com/aboutcode-org/vulnerablecode - |white_check_mark| ScanCode Workbench: desktop app for scan review: Separate project: - https://github.com/nexB/scancode-workbench + https://github.com/aboutcode-org/scancode-workbench - |white_large_square| DependentCode: dynamic dependencies resolutions: Separate project: https://github.com/nexB/dependentcode @@ -143,7 +143,7 @@ Package mining and matching ^^^^^^^^^^^^^^^^^^^^^^^^^^^ (Note that this will be a separate project) -Some code is in https://github.com/nexB/scancode-toolkit-contrib/ +Some code is in https://github.com/aboutcode-org/scancode-toolkit-contrib/ - |clock1030| exact matching - |clock1030| attribute-based matching diff --git a/docs/source/getting-started/home.rst b/docs/source/getting-started/home.rst index 4acfe645f73..c32b6979286 100644 --- a/docs/source/getting-started/home.rst +++ b/docs/source/getting-started/home.rst @@ -80,7 +80,7 @@ How does it work? Given a code directory, ScanCode will "scan code": - Extract files from any archive using a `universal archive extractor - `_ + `_ - Collect an inventory of the code files and classify the code using file types - Extract texts from binary files as needed diff --git a/docs/source/getting-started/install.rst b/docs/source/getting-started/install.rst index ff8601c7c27..a91cdd23e36 100644 --- a/docs/source/getting-started/install.rst +++ b/docs/source/getting-started/install.rst @@ -126,10 +126,10 @@ Installation as an Application: Downloading Releases ----------------------------------------------------- Get the Scancode Toolkit tarball archive of a specific version and your -operating system by going to the `project releases page `_ +operating system by going to the `project releases page `_ For example, Version 30.0.1 archive can be obtained from -`Toolkit release 30.0.1 `_ +`Toolkit release 30.0.1 `_ under assets options. .. Note:: @@ -198,7 +198,7 @@ Installation on Windows 10 ^^^^^^^^^^^^^^^^^^^^^^^^^^ - Download the latest ScanCode release zip file for Windows from the latest - version at https://github.com/nexB/scancode-toolkit/releases/ + version at https://github.com/aboutcode-org/scancode-toolkit/releases/ - In the File Explorer, select the downloaded ScanCode zip and right-click. @@ -274,7 +274,7 @@ The prerequisite is a working `docker installation `_ installed:: - git clone https://github.com/nexB/scancode-toolkit.git + git clone https://github.com/aboutcode-org/scancode-toolkit.git cd scancode-toolkit @@ -381,8 +381,8 @@ the standard Python package management tool. for ARM (like py-ahocorasick, intbitset). See :ref:`system_requirements` for more information. See related issues for more info: - - `Fallback pure-python deps `_ - - `pip install failing on M1 `_ + - `Fallback pure-python deps `_ + - `pip install failing on M1 `_ The steps are: diff --git a/docs/source/getting-started/newcomer.rst b/docs/source/getting-started/newcomer.rst index c4eb0ae8699..8fcdf7aabb8 100644 --- a/docs/source/getting-started/newcomer.rst +++ b/docs/source/getting-started/newcomer.rst @@ -91,7 +91,7 @@ Before you start using ScanCode Alternatively, you can also :ref:`source_code_install`. #. Run ``scancode -h`` to make sure Scancode was installed properly. - If this shows any Error, refer the `Common Installation Errors Issue `_ + If this shows any Error, refer the `Common Installation Errors Issue `_ for common errors. .. note:: @@ -121,7 +121,7 @@ Once you are all set up with Scancode Toolkit, i.e. Running ``scancode -h`` show follow the basic instructions. #. ScanCode generates output files with scan results. You can visualize ``JSON`` result files using - `Scancode Workbench `_. Follow this tutorial :ref:`how_to_visualize_scan_results` + `Scancode Workbench `_. Follow this tutorial :ref:`how_to_visualize_scan_results` to visualize the scan results. .. _newcomer_scancode_tips: @@ -156,8 +156,8 @@ The How-To's are: ScanCode Versions ^^^^^^^^^^^^^^^^^ -#. You can see all Scancode Toolkit versions on the `GitHub release page `_. -#. Read the `CHANGELOG `_ for more information on specific releases. +#. You can see all Scancode Toolkit versions on the `GitHub release page `_. +#. Read the `CHANGELOG `_ for more information on specific releases. #. If you want to use/test a specific version of Scancode Toolkit, you can follow the instructions in :ref:`source_code_install` docs. @@ -225,7 +225,7 @@ If you are looking to Contribute to Scancode Toolkit, this is where you start. General Information ^^^^^^^^^^^^^^^^^^^ -#. Also refer the `Contribution `_ page here. +#. Also refer the `Contribution `_ page here. #. For more Project Ideas, refer :ref:`contributor_project_ideas`. #. Before committing your work, make sure you have read this post on :ref:`good_commit_messages`. @@ -238,8 +238,8 @@ If you haven't contributed to Scancode Toolkit refer :ref:`newcomer_good_first_i To determine where to contribute, you can refer: -#. ScanCode Toolkit tracks issues via the `GitHub Issue tracker `_ -#. Broad `milestones `_ for upcoming versions are also maintained. +#. ScanCode Toolkit tracks issues via the `GitHub Issue tracker `_ +#. Broad `milestones `_ for upcoming versions are also maintained. And documentation related to contributing code can be referred at :ref:`contrib_code_dev`. @@ -248,7 +248,7 @@ And documentation related to contributing code can be referred at :ref:`contrib_ Good First Issues ^^^^^^^^^^^^^^^^^ -A `good first issue `_ +A `good first issue `_ means it's recommended for people who haven't contributed to Scancode Toolkit before. .. _newcomer_add_functionalirty: @@ -262,7 +262,7 @@ They are: #. Add the functionality to Scancode itself. #. Add plugins if the functionality is very much application dependent. -Refer `enhancement issues `_ for the first type of +Refer `enhancement issues `_ for the first type of enhancements. If you want to add a plugin to implement the functionality, refer all the :ref:`plugin_tutorials`. @@ -287,10 +287,10 @@ The sections in this page cover the following: You can contribute to the following Open Issues on documentation. -#. `First Timers Only Issues List `_ -#. `Documentation Inconsistencies Tracker `_ -#. `ScanCode Toolkit Documentation Roadmap `_ -#. `Issues with label Documentation `_ +#. `First Timers Only Issues List `_ +#. `Documentation Inconsistencies Tracker `_ +#. `ScanCode Toolkit Documentation Roadmap `_ +#. `Issues with label Documentation `_ .. note:: diff --git a/docs/source/how-to-guides/add_new_license.rst b/docs/source/how-to-guides/add_new_license.rst index b4db99f96e7..85b3a8bdd28 100644 --- a/docs/source/how-to-guides/add_new_license.rst +++ b/docs/source/how-to-guides/add_new_license.rst @@ -33,7 +33,7 @@ You need to create a file with: - the data attributes for the license in YAML format as `YAML frontmatter `_. -See an example license: `apache-2.0.LICENSE `_ +See an example license: `apache-2.0.LICENSE `_ There are a couple of mandatory attributes: diff --git a/docs/source/how-to-guides/generate_attribution.rst b/docs/source/how-to-guides/generate_attribution.rst index 2d852c5ac84..9deeb84f746 100644 --- a/docs/source/how-to-guides/generate_attribution.rst +++ b/docs/source/how-to-guides/generate_attribution.rst @@ -11,7 +11,7 @@ attrbution document from a ScanCode scan. Read more about AboutCode Toolkit here: https://aboutcode-toolkit.readthedocs.io/. -Check out the code at https://github.com/nexB/aboutcode-toolkit +Check out the code at https://github.com/aboutcode-org/aboutcode-toolkit Command in AboutCode Toolkit to generate attribution: https://aboutcode-toolkit.readthedocs.io/en/latest/reference.html#attrib. diff --git a/docs/source/misc/faq.rst b/docs/source/misc/faq.rst index 7c3a35ea8ec..ba6606deb99 100644 --- a/docs/source/misc/faq.rst +++ b/docs/source/misc/faq.rst @@ -68,7 +68,7 @@ Can I install ScanCode in a Unicode path? ----------------------------------------- Yes and this is fully supported and tested. See -https://github.com/nexB/scancode-toolkit/issues/867 +https://github.com/aboutcode-org/scancode-toolkit/issues/867 for a previous bug that was preventing this. There was a bug in virtualenv https://github.com/pypa/virtualenv/issues/457 that diff --git a/docs/source/misc/support.rst b/docs/source/misc/support.rst index 8dc9c6fc074..40dee1ba0eb 100644 --- a/docs/source/misc/support.rst +++ b/docs/source/misc/support.rst @@ -11,13 +11,13 @@ The ScanCode toolkit documentation lives at https://scancode-toolkit.readthedocs Issue Tracker ------------- -Post issues you are having and bugs as `GitHub tickets `_ +Post issues you are having and bugs as `GitHub tickets `_ Discussions ----------- If you want to ask questions or anything else that you think are not bugs/new -features, open a `discussion `_ +features, open a `discussion `_ Join the conversation ---------------------- diff --git a/docs/source/misc/versioning.rst b/docs/source/misc/versioning.rst index f2bc3619851..fdbf62ef5c9 100644 --- a/docs/source/misc/versioning.rst +++ b/docs/source/misc/versioning.rst @@ -54,4 +54,4 @@ adapted for data this way: - For any format version changes, we will provide a documentation on the format and its updates using JSON examples and a comprehensive and updated data - dictionary. See https://github.com/nexB/scancode-toolkit/issues/2008 for details. + dictionary. See https://github.com/aboutcode-org/scancode-toolkit/issues/2008 for details. diff --git a/docs/source/reference/license-detection-reference.rst b/docs/source/reference/license-detection-reference.rst index e7db1416816..b21135651bc 100644 --- a/docs/source/reference/license-detection-reference.rst +++ b/docs/source/reference/license-detection-reference.rst @@ -3,9 +3,9 @@ License Detection Updates References: -* `Issue `_ -* `Pull Request `_ -* `A presentation on this `_ +* `Issue `_ +* `Pull Request `_ +* `A presentation on this `_ The Problem: @@ -17,18 +17,18 @@ license_expressions. To tackle this the following solution elements were discuss implemented: 1. Reporting the primary, declared license in a scan summary record -2. tagging mandatory portions in rules `#2773 `_ -3. Adding license detections by combine multiple license matches `#2961 `_ +2. tagging mandatory portions in rules `#2773 `_ +3. Adding license detections by combine multiple license matches `#2961 `_ 4. Integrating the existing scancode-analyzer tool into SCTK to combine multiple matches - based on statistics and heuristics `#2961 `_ + based on statistics and heuristics `#2961 `_ 5. Reporting license clues when the matched license rule data is not sufficient to - create a LicenseDetection `#2961 `_ + create a LicenseDetection `#2961 `_ 6. web app for efficient scan and review of a single license to ease - reporting license detection issues `nexB/scancode.io#450 `_ -7. also apply LicenseDetection to package license detections `#2961 `_ -8. rename resource and package license fields `#2961 `_ + reporting license detection issues `nexB/scancode.io#450 `_ +7. also apply LicenseDetection to package license detections `#2961 `_ +8. rename resource and package license fields `#2961 `_ -Some other elements are still WIP, see `issue #3300 `_ for more details on this. +Some other elements are still WIP, see `issue #3300 `_ for more details on this. .. _what-is-a-licensedetection: @@ -180,8 +180,8 @@ Before:: "homepage_url": "http://www.apache.org/licenses/", "text_url": "http://www.apache.org/licenses/LICENSE-2.0", "reference_url": "https://scancode-licensedb.aboutcode.org/apache-2.0", - "scancode_text_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/apache-2.0.LICENSE", - "scancode_data_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/apache-2.0.yml", + "scancode_text_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/apache-2.0.LICENSE", + "scancode_data_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/apache-2.0.yml", "spdx_license_key": "Apache-2.0", "spdx_url": "https://spdx.org/licenses/Apache-2.0", "start_line": 1, @@ -233,7 +233,7 @@ After:: "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" } ], @@ -279,7 +279,7 @@ After:: "license_expression": "mit", "rule_identifier": "mit_in_manifest.RULE", "rule_relevance": 100, - "rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/mit_in_manifest.RULE", + "rule_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/rules/mit_in_manifest.RULE", "matched_text": ":type = MIT, :file = LICENSE" } ], @@ -337,7 +337,7 @@ For the corresponding resource level license detection:: "license_expression": "epl-1.0", "rule_identifier": "epl-1.0_3.RULE", "rule_relevance": 100, - "rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/epl-1.0_3.RULE", + "rule_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/rules/epl-1.0_3.RULE", }, { "score": 100.0, @@ -349,7 +349,7 @@ For the corresponding resource level license detection:: "license_expression": "epl-1.0", "rule_identifier": "epl-1.0_7.RULE", "rule_relevance": 100, - "rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/epl-1.0_7.RULE", + "rule_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/rules/epl-1.0_7.RULE", } ], "detection_log": [], @@ -399,8 +399,8 @@ Before:: "homepage_url": "http://www.gnu.org/licenses/gpl-2.0.html", "text_url": "http://www.gnu.org/licenses/gpl-2.0.txt", "reference_url": "https://scancode-licensedb.aboutcode.org/gpl-2.0", - "scancode_text_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/gpl-2.0.LICENSE", - "scancode_data_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/gpl-2.0.yml", + "scancode_text_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/gpl-2.0.LICENSE", + "scancode_data_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/gpl-2.0.yml", "spdx_license_key": "GPL-2.0-only", "spdx_url": "https://spdx.org/licenses/GPL-2.0-only", "start_line": 4, @@ -438,10 +438,10 @@ Before:: "homepage_url": null, "text_url": "", "reference_url": "https://scancode-licensedb.aboutcode.org/patent-disclaimer", - "scancode_text_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/patent-disclaimer.LICENSE", - "scancode_data_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/patent-disclaimer.yml", + "scancode_text_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/patent-disclaimer.LICENSE", + "scancode_data_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/patent-disclaimer.yml", "spdx_license_key": "LicenseRef-scancode-patent-disclaimer", - "spdx_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/patent-disclaimer.LICENSE", + "spdx_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/patent-disclaimer.LICENSE", "start_line": 4, "end_line": 30, "matched_rule": { @@ -489,7 +489,7 @@ After:: "license_expression": "gpl-2.0 AND patent-disclaimer", "rule_identifier": "gpl-2.0_and_patent-disclaimer_3.RULE", "rule_relevance": 100, - "rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/gpl-2.0_and_patent-disclaimer_3.RULE" + "rule_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/rules/gpl-2.0_and_patent-disclaimer_3.RULE" } ], "identifier": "gpl_2_0_and_patent_disclaimer-3bb2602f-86f5-b9da-9bf5-b52e6920c8d1" @@ -566,7 +566,7 @@ Before:: "matcher": "1-hash", "license_expression": "apache-2.0", "rule_identifier": "apache-2.0_65.RULE", - "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", "referenced_filenames": [], "is_license_text": false, "is_license_notice": false, @@ -588,7 +588,7 @@ Before:: "homepage_url": "http://www.apache.org/licenses/", "text_url": "http://www.apache.org/licenses/LICENSE-2.0", "reference_url": "https://scancode-licensedb.aboutcode.org/apache-2.0", - "scancode_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/apache-2.0.LICENSE", + "scancode_url": "https://github.com/aboutcode-org/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/apache-2.0.LICENSE", "spdx_license_key": "Apache-2.0", "spdx_url": "https://spdx.org/licenses/Apache-2.0" } @@ -638,7 +638,7 @@ After:: { "license_expression": "apache-2.0", "rule_identifier": "apache-2.0_65.RULE", - "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", "referenced_filenames": [], "is_license_text": false, "is_license_notice": false, @@ -671,7 +671,7 @@ After:: "license_expression": "apache-2.0", "rule_identifier": "apache-2.0_65.RULE", "matched_text": "License: Apache-2.0", - "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" } ] } @@ -692,4 +692,4 @@ detections. See the :ref:`license_detections_unique` above for more details on this. There could be a list of ambiguous detections as a summary to review. -This is WIP, see `scancode-toolkit#3122 `_. +This is WIP, see `scancode-toolkit#3122 `_. diff --git a/docs/source/rst_snippets/custom_output_format.rst b/docs/source/rst_snippets/custom_output_format.rst index 697ded6c229..25f81923e1b 100644 --- a/docs/source/rst_snippets/custom_output_format.rst +++ b/docs/source/rst_snippets/custom_output_format.rst @@ -53,7 +53,7 @@ Now the results are saved in ``output.txt`` and we can easily view them with ``h copyright:"copyrighted by the Free Software Foundation", ] -For a more elaborate template, refer this `default template `_ +For a more elaborate template, refer this `default template `_ given with Scancode, to generate HTML output with the ``--html`` output format option. Documentation on `Jinja templates `_. diff --git a/docs/source/rst_snippets/improve_docs.rst b/docs/source/rst_snippets/improve_docs.rst index 04a3a2d6d39..43e524ee543 100644 --- a/docs/source/rst_snippets/improve_docs.rst +++ b/docs/source/rst_snippets/improve_docs.rst @@ -2,6 +2,6 @@ Something Missing? ------------------ If something is missing in the documentation or if you found some part confusing, please file -an `issue `_ with your suggestions for +an `issue `_ with your suggestions for improvement. Use the "Documentation Improvement" template. Your help makes ScanCode docs better, we love hearing from you! diff --git a/docs/source/rst_snippets/note_snippets/output_htmlapp_search.rst b/docs/source/rst_snippets/note_snippets/output_htmlapp_search.rst index 308b5e833c8..a091591897f 100644 --- a/docs/source/rst_snippets/note_snippets/output_htmlapp_search.rst +++ b/docs/source/rst_snippets/note_snippets/output_htmlapp_search.rst @@ -2,4 +2,4 @@ The HTML app also contains a Search option to easily find what you are looking for. But the HTML app output is deprecated and we recommend using scancode-workbench instead: - https://github.com/nexB/scancode-workbench. + https://github.com/aboutcode-org/scancode-workbench. diff --git a/docs/source/rst_snippets/output_format_options.rst b/docs/source/rst_snippets/output_format_options.rst index 7bb42d5fc16..859a7608f60 100644 --- a/docs/source/rst_snippets/output_format_options.rst +++ b/docs/source/rst_snippets/output_format_options.rst @@ -20,7 +20,7 @@ All Scan Output Options new CSV and tabular output formats in the next ScanCode release. Visit this issue for details, and to provide input and feedback: - https://github.com/nexB/scancode-toolkit/issues/3043 + https://github.com/aboutcode-org/scancode-toolkit/issues/3043 --html FILE Write scan output as HTML to FILE. diff --git a/docs/source/rst_snippets/warning_snippets/output_htmlapp_dep.rst b/docs/source/rst_snippets/warning_snippets/output_htmlapp_dep.rst index afec603f48f..9f272c4750c 100644 --- a/docs/source/rst_snippets/warning_snippets/output_htmlapp_dep.rst +++ b/docs/source/rst_snippets/warning_snippets/output_htmlapp_dep.rst @@ -1,5 +1,5 @@ .. WARNING:: The html-app feature has been deprecated and you should use Scancode Workbench instead - to visualize scan results. The official Repository `link `_. + to visualize scan results. The official Repository `link `_. Also refer :ref:`how_to_visualize_scan_results`. diff --git a/docs/source/tutorials/how_to_add_a_post_scan_plugin.rst b/docs/source/tutorials/how_to_add_a_post_scan_plugin.rst index ea6aa728f3a..d773554e043 100644 --- a/docs/source/tutorials/how_to_add_a_post_scan_plugin.rst +++ b/docs/source/tutorials/how_to_add_a_post_scan_plugin.rst @@ -66,10 +66,10 @@ Built-In ^^^^^^^^ Some post-scan plugins are installed when ScanCode itself is installed, and they are specified at -``[options.entry_points]`` in the `setup.cfg `_ file. +``[options.entry_points]`` in the `setup.cfg `_ file. For example, the :ref:`license_policy_plugin` is a built-in plugin, whose code is located here:: - https://github.com/nexB/scancode-toolkit/blob/develop/src/licensedcode/plugin_license_policy.py + https://github.com/aboutcode-org/scancode-toolkit/blob/develop/src/licensedcode/plugin_license_policy.py These plugins do not require any additional installation steps and can be used as soon as ScanCode is up and running. @@ -80,7 +80,7 @@ Optional ScanCode is also designed to use post-scan plugins that must be installed separately from the installation of ScanCode. The code for this sort of plugin is located here:: - https://github.com/nexB/scancode-plugins + https://github.com/aboutcode-org/scancode-plugins This wiki page will focus on optional post-scan plugins. @@ -112,7 +112,7 @@ We'll start by creating three folders: The 7 Files are: 1. ``.gitignore`` -- See, e.g., - `/scancode-ignore-binaries/.gitignore `_ + `/scancode-ignore-binaries/.gitignore `_ :: @@ -120,7 +120,7 @@ The 7 Files are: /dist/ 2. ``apache-2.0.LICENSE`` -- See, e.g., - `/scancode-ignore-binaries/apache-2.0.LICENSE `_ + `/scancode-ignore-binaries/apache-2.0.LICENSE `_ 3. ``MANIFEST.in`` @@ -139,7 +139,7 @@ The 7 Files are: global-exclude *.py[co] __pycache__ *.*~ 4. ``NOTICE`` -- See, e.g., - `/scancode-ignore-binaries/NOTICE `__ + `/scancode-ignore-binaries/NOTICE `__ 5. ``README.md`` @@ -185,7 +185,7 @@ The 7 Files are: long_description=desc, author='nexB', author_email='info@aboutcode.org', - url='https://github.com/nexB/scancode-plugins/blob/main/misc/scancode-hello/', + url='https://github.com/aboutcode-org/scancode-plugins/blob/main/misc/scancode-hello/', packages=find_packages('src'), package_dir={'': 'src'}, py_modules=[splitext(basename(path))[0] for path in glob('src/*.py')], @@ -311,6 +311,6 @@ One good example is the License Policy post-scan plugin. This plugin is installe is installed and consequently is not located in the ``/plugins/`` directory used for manually-installed post-scan plugins. The code for the License Policy plugin can be found at `/scancode-toolkit/src/licensedcode/plugin_license_policy.py -`_ +`_ and illustrates how a plugin can be used to analyze the results of a ScanCode scan using external data files and add the results of that analysis as a new field in the ScanCode JSON output file. diff --git a/docs/source/tutorials/how_to_set_what_will_be_detected_in_a_scan.rst b/docs/source/tutorials/how_to_set_what_will_be_detected_in_a_scan.rst index 2380eb28780..e501b124d83 100644 --- a/docs/source/tutorials/how_to_set_what_will_be_detected_in_a_scan.rst +++ b/docs/source/tutorials/how_to_set_what_will_be_detected_in_a_scan.rst @@ -13,7 +13,7 @@ Different Scans --------------- The following examples will use the ``samples`` directory that is provided with the `ScanCode -Toolkit code `_. All examples will +Toolkit code `_. All examples will be saved in the JSON format, which can be loaded into Scancode Workbench for visualization. See :ref:`how_to_visualize_scan_results` for more information. Another output format option is a static html file. See :ref:`cli_output_format` for more information. diff --git a/docs/source/tutorials/how_to_visualize_scan_results.rst b/docs/source/tutorials/how_to_visualize_scan_results.rst index f88b5b108ab..041092a012a 100644 --- a/docs/source/tutorials/how_to_visualize_scan_results.rst +++ b/docs/source/tutorials/how_to_visualize_scan_results.rst @@ -12,5 +12,5 @@ Detailed Installation and Usage guide can be found here - :ref:`scancode-workbe This tutorial uses the 32.x version of Scancode Toolkit, and Scancode Workbench 4.0.x (This version of ScanCode Workbench is compatible with scans from any ScanCode Toolkit develop version/branch at or after v32.x). If you are using an older version of Scancode Toolkit, check respective versions of this documentation. Also refer the Scancode Workbench - `release highlights `_. + `release highlights `_. ..