Skip to content

Add "Profile" to Terms and defintions - #1095

Merged
goneall merged 3 commits into
spdx:development/v3.0.1from
bact:add-profile-to-terms
Aug 29, 2024
Merged

goneall merged 3 commits into
spdx:development/v3.0.1from
bact:add-profile-to-terms

Conversation

@bact

@bact bact commented Aug 27, 2024

Copy link
Copy Markdown
Collaborator

Will resolve #1088

Please suggest style/format of the definition list.

--

Currently, it put terms as a H2 heading, with definition as following paragraphs.

As a result, terms will also showing in the side navigation bar.

Screenshot 2024-08-27 at 20 18 08

--

Alternatively, it is also possible in MkDocs to use a Markdown syntax to generate standard HTML tags for a definition list (<dl> for list, <dt> for term, and <dd> for description), which in general will work better with a screen reader:

This code:

Profile

:   A scope of usage for SPDX targeting support for particular use cases and scenarios (e.g., software, licensing, security, etc.).

    A profile identifies which particular SPDX namespaces, classes, and properties it leverages, along with any custom constraints unique to its use.

Test

:   Test test

will generate

Screenshot 2024-08-27 at 20 18 56

--

Which one we prefer?

With the compatibility with our current PDF generation in mind.

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact bact added this to the 3.0.1 milestone Aug 27, 2024
@bact
bact requested review from goneall and zvr August 27, 2024 19:43

@goneall goneall left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bact
bact requested a review from kestewart August 28, 2024 06:16
Comment thread docs/terms-and-definitions.md Outdated
Comment thread docs/terms-and-definitions.md Outdated
bact and others added 2 commits August 28, 2024 19:27
Co-authored-by: Alexios Zavras (zvr) <zvr+git@zvr.gr>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
bact requested a review from zvr August 28, 2024 18:29
@goneall
goneall merged commit 38870b9 into spdx:development/v3.0.1 Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add terms

3 participants