Merge pull request #411 from nexB/symbol-string-docs

Add tutorial for symbol and string collection using `/api/collect` endpoint
aboutcode-org · May 10, 2024 · 972e714 · 972e714
2 parents ff5fd35 + 7db678c
commit 972e714
Show file tree

Hide file tree

Showing 9 changed files with 436 additions and 90 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -6,6 +6,11 @@ Next Release
 
 - Add `/api/from_purl/purl2git` endpoint to get a git repo for a purl.
 - Add `/api/to_purl/go` endpoint to get a purl from a golang import string or a package string in go.mod.
+- Support indexing of PURLs listed in https://github.com/nexB/purldb/issues/326,
+  https://github.com/nexB/purldb/issues/327, https://github.com/nexB/purldb/issues/328,
+  https://github.com/nexB/purldb/issues/329 and https://github.com/nexB/purldb/issues/356.
+- Support ``addon_pipelines`` for symbol and string collection in ``/api/collect`` endpoint. https://github.com/nexB/purldb/pull/393 
+- Store ``source_symbols`` and ``source_strings`` in ``extra_data`` field. https://github.com/nexB/purldb/pull/351
 
 
 v4.0.0

diff --git a/docs/source/how-to-guides/index.rst b/docs/source/how-to-guides/index.rst
@@ -11,4 +11,4 @@ thourgh specifica use cases:
    :maxdepth: 2
 
    matchcode
-   purl2sym
+   tutorial_symbol_and_string_collection
diff --git a/docs/source/how-to-guides/purl2sym.rst b/docs/source/how-to-guides/purl2sym.rst