Skip to content

Commit

Permalink
Minor tweaks to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mprpic committed Aug 15, 2024
1 parent 6a140ad commit 23d14c2
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 11 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
# security-data-guidelines
A set of documents detailing Red Hat's publishing of security data.


## Docs Development

To run a locally served docs site, run:

```
python3 -m venv venv
source venv/bin/activate
pip install -r requirements/docs-requirements.txt
mkdocs serve
```
16 changes: 9 additions & 7 deletions docs/purl.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,12 @@ that present different sets of qualifiers may still point to the same object. A
understanding this concept that is worth quoting here can be found in
[issue #242](https://github.com/package-url/purl-spec/issues/242) in the purl-spec:

> Each package type is like a country or state and defines how you can identify and locate a place reasonably
> uniquely. Uniquely enough that the post can deliver the mail. In a city with well[-]defined streets and street
> numbers, you get a precise location with the street name and number and may be an apartment number. In some cases
> you may want the address for a single person with its name, or the whole household. If someone is off the grid in
> the bayou or some isolated mountain, crafting a proper address may be more hairy and fuzzy. Worst case I may need
> GPS coordinates for these edge cases. I may also have many different ways to write an address or a name. Heck,
> some folks also live in orbit on the ISS and GPS will not work there!
!!! quote

_Each package type is like a country or state and defines how you can identify and locate a place reasonably
uniquely. Uniquely enough that the post can deliver the mail. In a city with well-defined streets and street
numbers, you get a precise location with the street name and number and may be an apartment number. In some cases
you may want the address for a single person with its name, or the whole household. If someone is off the grid in
the bayou or some isolated mountain, crafting a proper address may be more hairy and fuzzy. Worst case I may need
GPS coordinates for these edge cases. I may also have many different ways to write an address or a name. Heck,
some folks also live in orbit on the ISS and GPS will not work there!_
13 changes: 9 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
site_name: Red Hat Security Data Guidelines
site_url: https://redhatproductsecurity.github.io/security-data-guidelines/
edit_uri: "https://github.com/RedHatProductSecurity/security-data-guidelines/blob/main/docs"
copyright: Copyright &copy; Red Hat, Inc. &nbsp;&centerdot;&nbsp; <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0</a>

theme:
name: material
Expand All @@ -12,7 +13,7 @@ theme:
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotation
- content.code.annotate
- content.code.copy
- content.action.view
language: en
Expand Down Expand Up @@ -46,12 +47,16 @@ extra:
link: "mailto:[email protected]"

markdown_extensions:
- pymdownx.highlight:
linenums: true
anchor_linenums: true
- pymdownx.highlight
- pymdownx.inlinehilite # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=snippets#inlinehilite
- pymdownx.snippets # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=snippets#snippets
- admonition # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=#admonition
- footnotes # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=#footnotes
- attr_list
- abbr # https://squidfunk.github.io/mkdocs-material/reference/tooltips/#adding-abbreviations
- md_in_html
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: 🔗 # Add anchor to each title element

0 comments on commit 23d14c2

Please sign in to comment.