From 23d14c2321e7fa4dbfbfecbfa7b5588d44fa8b4c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Prpi=C4=8D?= Date: Thu, 15 Aug 2024 14:17:17 -0400 Subject: [PATCH] Minor tweaks to docs --- README.md | 12 ++++++++++++ docs/purl.md | 16 +++++++++------- mkdocs.yml | 13 +++++++++---- 3 files changed, 30 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ac294a7..a0e82de 100644 --- a/README.md +++ b/README.md @@ -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 +``` diff --git a/docs/purl.md b/docs/purl.md index 96b769a..ae9d3a8 100644 --- a/docs/purl.md +++ b/docs/purl.md @@ -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!_ diff --git a/mkdocs.yml b/mkdocs.yml index db01534..939d643 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 © Red Hat, Inc.  ·  CC BY 4.0 theme: name: material @@ -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 @@ -46,12 +47,16 @@ extra: link: "mailto:secalert@redhat.com" 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