Skip to content

Commit 7ca4d8c

Browse files
committed
Update .md files #657
Reference: #657 Signed-off-by: johnmhoran <johnmhoran@gmail.com>
1 parent cc5bf3f commit 7ca4d8c

File tree

2 files changed

+11
-17
lines changed

2 files changed

+11
-17
lines changed

docs/known-qualifiers.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ all package types:
3232
Python pip or the SPDX specification. See
3333
https://github.com/spdx/spdx-spec/blob/cfa1b9d08903/chapters/3-package-information.md#37-package-download-location
3434

35-
- TODO: incorporate the details from SPDX here.
36-
3735
- `file_name` is an extra file name of a package archive.
3836

3937
- `checksum` is a qualifier for one or more checksums stored as a

docs/standard/types.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,23 @@
33
Each package manager, platform, type, or ecosystem has its own conventions
44
and protocols to identify, locate, and provision software packages.
55

6-
The package **type** is the component of a Package-URL that is used to
6+
The package `type` is the component of a Package-URL that is used to
77
capture this information with a short string such as `maven`, `npm`,
88
`nuget`, `gem`, `pypi`, etc.
99

10-
These are registered PURL package type definitions.
10+
PURL type definitions are maintained in a set of JSON Schema files with a
11+
separate file for each `purl` `type`. Each `purl` `type` has a corresponding
12+
file of automatically generated documentation. There is also a simple index
13+
of all currently registered purl types.
1114

12-
Definitions can also include types reserved for future use.
15+
## Where to find PURL type information
1316

14-
This document no longer contains a manually maintained list of PURL types.
15-
16-
Instead, all PURL type definitions are now maintained in a simple JSON
17-
document with automatically generated documentation.
18-
19-
## Where to find PURL Type information
20-
21-
- In the JSON Index listing of all defined PURL types at:
22-
https://github.com/package-url/purl-spec/tree/main/purl-types-index.json
23-
24-
- In individual JSON files, one for each PURL type definition at:
17+
- In individual JSON files, one for each `purl` `type` definition at:
2518
https://github.com/package-url/purl-spec/tree/main/types
2619

27-
- As Markdown documentation, generated from for each PURL type JSON
20+
- As Markdown documentation, generated from each `purl` `type` JSON
2821
definition at:
2922
https://github.com/package-url/purl-spec/tree/main/types-doc
23+
24+
- In the JSON Index listing of all registered PURL types at:
25+
https://github.com/package-url/purl-spec/tree/main/purl-types-index.json

0 commit comments

Comments
 (0)