Skip to content

Commit 3b45517

Browse files
authored
fix PURL in README
We need to consistently use Package-URL or PURL.
1 parent 5f3577c commit 3b45517

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ To install `minecode-pipelines` with scancode.io:
99
* Specify the federatedcode settings in ``.env`` file
1010
* Run ``make clean && make dev-mining && make run``
1111
* Then select and start the mining pipeline according to which ecosystem
12-
you want to mine packageURLs from.
12+
you want to mine Package-URLs (PURLs) from.
1313

1414
Configuration format
1515
=======================
1616

1717
* configuration/checkpoints for each ecossytem would be stored in a root folder
1818
with the same name as the package type defined in https://github.com/package-url/purl-spec (example: ``pypi``)
1919

20-
* ``checkpoints.json`` stores checkpoints related to the package URL mining like:
20+
* ``checkpoints.json`` stores checkpoints related to the PURL mining like:
2121

2222
* last serial number processed (used in indexes at pypi, npm etc)
2323
* last processed commit (where the data is stored in git repos)
@@ -27,15 +27,15 @@ Configuration format
2727

2828
* ``null``: mining has not started.
2929
* ``initital-sync`` : at the start of mining we need to mine a huge
30-
amount of packages for packageURL to catch up.
30+
amount of packages for PURL to catch up.
3131
This is typically very large and could take several hours to several days
3232
dependening on the ecosystem size.
33-
We fetch and save an index state and mine all packageURLs till there.
33+
We fetch and save an index state and mine all PURLs till there.
3434
Once we reach a state where remaining
35-
new packageURLs can be mined in a couple hours, we can move on to
36-
the next state where we mine new packageURLs
35+
new PURLs can be mined in a couple hours, we can move on to
36+
the next state where we mine new PURLs
3737
added in a periodic manner.
38-
* ``periodic-sync`` : This is a periodic update of new packageURLs
38+
* ``periodic-sync`` : This is a periodic update of new PURLs
3939
added in the index in a period, and typically this
4040
should not take more than a couple hours.
4141

0 commit comments

Comments
 (0)