Skip to content

Commit 75d695d

Browse files
author
DennisClark
committed
Remove test comments from documents
1 parent 505e414 commit 75d695d

4 files changed

Lines changed: 43 additions & 9 deletions

File tree

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# -- Project information -----------------------------------------------------
1919

2020
project = 'AboutCode'
21-
copyright = 'Copyright 2019 AboutCode.org'
21+
copyright = '2019 AboutCode.org'
2222
author = 'AboutCode.org'
2323

2424

docs/source/help.rst

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
11
Help
22
====
33

4-
Help is always available when you are in need.
4+
AboutCode is a suite of open source projects.
55

6-
Further Help
7-
************
6+
AboutCode Projects
7+
******************
8+
9+
- **[ScanCode Toolkit](https://github.com/nexB/scancode-toolkit)**: This is a set of code scanning tools to detect the origin and license of code and dependencies. ScanCode Toolkit 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 hundreds of software teams. https://github.com/nexB/scancode-toolkit . The lead maintainer is @pombredanne
10+
11+
- **[Scancode Workbench](https://github.com/nexB/scancode-workbench)** (formerly AboutCode Manager) This is a desktop application (based on Electron) to review the results of a scan and document your conclusions about the origin and license of software components and packages. https://github.com/nexB/aboutcode-manager . The lead maintainer is @majurg
12+
13+
- **[AboutCode Toolkit](https://github.com/nexB/aboutcode-toolkit)**: This 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. https://github.com/nexB/aboutcode-toolkit . The lead maintainer is @chinyeungli
14+
15+
- **[TraceCode Toolkit](https://github.com/nexB/tracecode-toolkit)**: This is 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
16+
17+
- **[Conan](https://github.com/nexB/conan)**: "conan" stands for "CONtainer ANalysis" and is a tool to analyze the structure and provenance of software components in Docker images using static analysis. https://github.com/nexB/conan Maintained by @pombredanne
18+
19+
- **[license-expression](https://github.com/nexB/license-expression/)**: This is a library to parse, analyze, compare and normalize SPDX-like license expressions using a boolean logic expression engine. See https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60 to understand what a license expression is. See https://github.com/nexB/license-expression for the code. The underlying boolean engine is at https://github.com/bastikr/boolean.py . Both are co-maintained by @pombredanne
20+
21+
- **ABCD aka AboutCode Data** is a simple set of conventions to define data structures that all the AboutCode tools can understand and use to exchange data. The specification lives in this repository. .ABOUT files and ScanCode tooklit data are examples of this approach. Other projects such as https://libraries.io and [OSS Review Toolkit](https://github.com/heremaps/oss-review-toolkit) also use these conventions.
22+
23+
- **[DeltaCode](https://github.com/nexB/deltacode)** is a command line tool to compare scans and determine if and where there are material differences that affect licensing. The lead maintainer is @majurg
24+
25+
- **[VulnerableCode](https://github.com/nexB/vulnerablecode)**: an emerging server-side application to collect and track known package vulnerabilities.
826

9-
Further help is available if you are totally stuck.

docs/source/index.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,28 @@ Guide
1111
help
1212

1313

14+
Tutorial Documents
15+
==================
16+
17+
Tutorial documents provide specific instructions to help you get started.
18+
19+
20+
How-To Documents
21+
================
22+
23+
How-To documents explain how to accomplish specific tasks.
24+
25+
1426
Reference Documents
1527
===================
1628

17-
Here is an explanation of some complicated stuff::
29+
Reference documents describe application concepts in depth.
30+
31+
32+
Discussion Documents
33+
====================
1834

19-
print 'hello'
20-
>> hello
35+
Discussion documents provide insights into integration of the application into your own software development life cycle.
2136

2237

2338
Indices and Tables

docs/source/license.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
License
22
=======
33

4-
This documentation is released to the public domain by the authors.
4+
AboutCode includes documents that are dedicated to the Public Domain using the
5+
Creative Commons CC0 1.0 Universal (CC0 1.0) Public Domain Dedication:
6+
http://creativecommons.org/publicdomain/zero/1.0/

0 commit comments

Comments
 (0)