Skip to content

Commit 20b146e

Browse files
authored
Merge pull request #135 from johnmhoran/93-update-definitions
Update definitions, documentation URLs #93
2 parents 92e6b64 + 05ac15a commit 20b146e

5 files changed

Lines changed: 10 additions & 10 deletions

File tree

website/src/data/project_field_help.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
"name": "The name of this AboutCode project.",
33
"description": "Short description of the project.",
44
"repository_url": "URL for the the project's GitHub repository.",
5-
"documentation_url": "URL for the primary project documentation - at ReadtheDocs for larger projects and on GitHub for smaller projects.",
5+
"documentation_url": "URL for the primary project documentation.",
66
"package_download_url": "URL for downloading one or more packages published by this project to PyPI or another package manager repository.",
7-
"service_url": "URL for API access to a data service or a demonstration system hosted by AboutCode.",
7+
"service_url": "URL for access to an API data service or a demonstration system hosted by AboutCode.",
88
"languages": "Primary language(s) used for software development in this project.",
99
"software_license": "The open source license that applies to the software from this project.",
10-
"data_license": "The open source license that applies to a dataset or data service mainained by this project.",
10+
"data_license": "The open source license that applies to a dataset or data service maintained by this project.",
1111
"platform": "The primary platform for deploying the project software. This could be Python (meaning a Python environment), Docker, an operating system, a CI/CD system or other platform.",
1212
"lead_maintainer": "The lead maintainer (or maintainers for this project). Please communicate with maintainers inside GitHub using discussions, issues or pull requests."
1313
}

website/src/data/projects-application.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"name": "dejacode",
55
"description": ["DejaCode provides an enterprise-level application to automate open source license compliance and ensure software supply chain integrity, powered by ScanCode."],
66
"repository_url": "https://github.com/aboutcode-org/dejacode",
7-
"documentation_url": "https://dejacode.readthedocs.io/en/latest/",
7+
"documentation_url": "https://dejacode.readthedocs.io/en/stable/",
88
"package_download_url": ["https://pypi.org/project/dejacode/"],
99
"service_url": "https://public.dejacode.com/account/register/",
1010
"languages": "Python",
@@ -32,7 +32,7 @@
3232
"name": "vulnerablecode",
3333
"description": ["VulnerableCode provides a Web UI and API to access a database of known software package vulnerabilities with comprehensive information from upstream and downstream public sources including packages affected by a vulnerability and packages that fix a vulnerability. There is a public VulnerableCode database at: https://public.vulnerablecode.io/ and the project also provides the tools to build your own instance of the database."],
3434
"repository_url": "https://github.com/aboutcode-org/vulnerablecode",
35-
"documentation_url": "https://vulnerablecode.readthedocs.io/en/latest/",
35+
"documentation_url": "https://vulnerablecode.readthedocs.io/en/stable/",
3636
"package_download_url": ["https://pypi.org/project/vulnerablecode/", "https://pypi.org/project/aboutcode.federated/", "https://pypi.org/project/aboutcode.hashid/"],
3737
"service_url": "https://public2.vulnerablecode.io/",
3838
"languages": "Python",

website/src/data/projects-libraries.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"name": "ag-gen-code-search",
55
"description": ["Open source tools to find code that may have been generated using LLMs and GPT tools."],
66
"repository_url": "https://github.com/aboutcode-org/ai-gen-code-search",
7-
"documentation_url": "https://ai-gen-code-search.readthedocs.io/en/latest/",
7+
"documentation_url": "https://ai-gen-code-search.readthedocs.io/en/stable/",
88
"package_download_url": ["https://pypi.org/project/samecode/"],
99
"service_url": "Not applicable",
1010
"languages": "Python",

website/src/data/projects-package-url.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"name": "purldb",
55
"description": ["PURLDB provides tools to create and update a database of package metadata keyed by PURL (Package URL) and an API for the PURL data."],
66
"repository_url": "https://github.com/aboutcode-org/purldb",
7-
"documentation_url": "https://aboutcode.readthedocs.io/projects/PURLdb/en/latest/",
7+
"documentation_url": "https://github.com/aboutcode-org/purldb/blob/main/README.rst",
88
"package_download_url": ["https://pypi.org/project/minecode-pipelines/", "https://pypi.org/project/purl2vcs/"],
99
"service_url": "https://public.purldb.io/api/",
1010
"languages": "Python",

website/src/data/projects-scancode.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"name": "scancode-workbench",
3333
"description": ["ScanCode Workbench is an application to visualize and review scan results from ScanCode Toolkit scans. You can install and use the Workbench on a Linux, MacOS or Windows desktop."],
3434
"repository_url": "https://github.com/aboutcode-org/scancode-workbench",
35-
"documentation_url": "https://scancode-workbench.readthedocs.io/",
35+
"documentation_url": "https://scancode-workbench.readthedocs.io/latest",
3636
"package_download_url": ["https://github.com/aboutcode-org/scancode-workbench/releases/"],
3737
"service_url": "Not applicable",
3838
"languages": "Electron",
@@ -102,7 +102,7 @@
102102
"name": "federatedcode",
103103
"description": ["federatedcode is a decentralized, federated metadata system for open source software code and security information."],
104104
"repository_url": "https://github.com/aboutcode-org/federatedcode",
105-
"documentation_url": "https://federatedcode.readthedocs.io/",
105+
"documentation_url": "https://federatedcode.readthedocs.io/en/stable/",
106106
"package_download_url": ["https://pypi.org/project/aboutcode.federatedcode/"],
107107
"service_url": "Not applicable",
108108
"languages": "Python",
@@ -116,7 +116,7 @@
116116
"name": "aboutcode-toolkit",
117117
"description": ["aboutcode-toolkit is 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."],
118118
"repository_url": "https://github.com/aboutcode-org/aboutcode-toolkit",
119-
"documentation_url": "https://aboutcode.readthedocs.io/projects/aboutcode-toolkit/en/latest/",
119+
"documentation_url": "https://aboutcode.readthedocs.io/projects/aboutcode-toolkit/en/stable/",
120120
"package_download_url": ["https://pypi.org/project/aboutcode-toolkit/", "https://pypi.org/project/attributecode/"],
121121
"service_url": "Not applicable",
122122
"languages": "Python",

0 commit comments

Comments
 (0)