Remove incorrect bullet #1809
Remove incorrect bullet #1809
Conversation
Before this change, DOCS/faq.md said that the License List incorporated the syntax for license expressions. That’s not accurate. The syntax for license expressions is in the SPDX Spec [1]. Also, the link in that bullet point was invalid. [1]: <https://spdx.github.io/spdx-spec/v2.3/SPDX-license-expressions/>
Jayman2000
force-pushed
the
remove-incorrect-bullet
branch
from
36decf9 to
a949464
Compare
|
The license expression syntax is relevant to the use of the SPDX License List. I think it's worth including it in the FAQ (though agree with your note about the link being broken -- thanks for calling that out). But other than fixing the link, I would leave this bullet point in. |
I agree that it’s relevant to the License List, but that’s not what
In other words, this part of the FAQ says that the license expression syntax is a part of the License List, but the license expression syntax isn’t a part of the License List.
I agree. Even with this bullet removed, there’s still two different questions that link to the Spec’s license expression annex.
That’s what I was going to do originally, but I couldn’t find anything on the License List or in this repo that really described the syntax for license expressions. I was able to find two explanations of license expressions:
but those aren’t really descriptions of the syntax. Those are just overviews. |
|
@Jayman2000 - as the person who probably wrote this... I think the operative wording that leads this list is, "It is more than just a list, though. The SPDX License List incorporates" This is based on my observation that many people seem to view the webpage at https://spdx.org/licenses/ - and just look at the list (literally) there, skipping over the other information at the top of the page that explains context, bigger picture, etc. Hence, "it is more than just a list" - the list is what people primarily see, but what makes the list meaningful is more than what you see on the list... not sure that makes sense, but if there is a better way to express that, I'm all ears! |
The SPDX License List FAQ [1] tries to draw attention to the information written before the tables on the SPDX License List Web page [2]. The FAQ does this for a reason: “This is based on my observation that many people seem to view the webpage at https://spdx.org/licenses/ - and just look at the list (literally) there, skipping over the other information at the top of the page that explains context, bigger picture, etc.” [3] At the moment, the FAQ tries to draw attention to those sections in an awkward and slightly incorrect way [4]. This commit gives those sections ids so that spdx/license-list-XML#<PR> can add direct links to them. [1]: <https://github.com/spdx/license-list-XML/blob/main/DOCS/faq.md> [2]: <https://spdx.org/licenses/> [3]: <spdx/license-list-XML#1809 (comment)> [4]: <spdx/license-list-XML#1809 (comment)> TODO: • Proofread • Replace <PR> with the actual spdx/license-list-XML pull request number • Create a commit in license-list-XML that puts links to these headers in DOCS/faq.md
Before this change, there was an awkward and slightly incorrect part of the FAQ [1]. It was trying to draw attention to specific parts of the License List Web page that typically get ignored [2]. This replaces that part of the FAQ with a more direct call out. Hopefully, this will make people pay more attention to those parts of the License List. [1]: <spdx#1809 (comment)> [2]: <spdx#1809 (comment)> TODO: • Proofread • Test
The SPDX License List FAQ [1] tries to draw attention to the information written before the tables on the SPDX License List Web page [2]. The FAQ does this for a reason: “This is based on my observation that many people seem to view the webpage at https://spdx.org/licenses/ - and just look at the list (literally) there, skipping over the other information at the top of the page that explains context, bigger picture, etc.” [3] At the moment, the FAQ tries to draw attention to those sections in an awkward and slightly incorrect way [4]. This commit gives those sections ids so that spdx/license-list-XML#<PR> can add direct links to them. [1]: <https://github.com/spdx/license-list-XML/blob/main/DOCS/faq.md> [2]: <https://spdx.org/licenses/> [3]: <spdx/license-list-XML#1809 (comment)> [4]: <spdx/license-list-XML#1809 (comment)> TODO: • Replace <PR> with the actual spdx/license-list-XML pull request number
Before this change, there was an awkward and slightly incorrect part of the FAQ [1]. It was trying to draw attention to specific parts of the License List Web page that typically get ignored [2]. This replaces that part of the FAQ with a more direct call out. Hopefully, this will make people pay more attention to those parts of the License List. [1]: <spdx#1809 (comment)> [2]: <spdx#1809 (comment)> TODO: • Test
Before this change, there was an awkward and slightly incorrect part of the FAQ [1]. It was trying to draw attention to specific parts of the License List Web page that typically get ignored [2]. This replaces that part of the FAQ with a more direct call out. Hopefully, this will make people pay more attention to those parts of the License List. This change also removes an invalid link. [1]: <spdx#1809 (comment)> [2]: <spdx#1809 (comment)>
The SPDX License List FAQ [1] tries to draw attention to the information written before the tables on the SPDX License List Web page [2]. The FAQ does this for a reason: “This is based on my observation that many people seem to view the webpage at https://spdx.org/licenses/ - and just look at the list (literally) there, skipping over the other information at the top of the page that explains context, bigger picture, etc.” [3] At the moment, the FAQ tries to draw attention to those sections in an awkward and slightly incorrect way [4]. This commit gives those sections ids so that spdx/license-list-XML#<PR> can add direct links to them. [1]: <https://github.com/spdx/license-list-XML/blob/main/DOCS/faq.md> [2]: <https://spdx.org/licenses/> [3]: <spdx/license-list-XML#1809 (comment)> [4]: <spdx/license-list-XML#1809 (comment)> TODO: • Replace <PR> with the actual spdx/license-list-XML pull request number
The SPDX License List FAQ [1] tries to draw attention to the information written before the tables on the SPDX License List Web page [2]. The FAQ does this for a reason: “This is based on my observation that many people seem to view the webpage at https://spdx.org/licenses/ - and just look at the list (literally) there, skipping over the other information at the top of the page that explains context, bigger picture, etc.” [3] At the moment, the FAQ tries to draw attention to those sections in an awkward and slightly incorrect way [4]. This commit gives those sections anchors so that spdx/license-list-XML#<PR> can add direct links to them. [1]: <https://github.com/spdx/license-list-XML/blob/main/DOCS/faq.md> [2]: <https://spdx.org/licenses/> [3]: <spdx/license-list-XML#1809 (comment)> [4]: <spdx/license-list-XML#1809 (comment)> TODO: • Replace <PR> with the actual spdx/license-list-XML pull request number
I just opened #1826 which tries to express that idea in a better way. |
The SPDX License List FAQ [1] tries to draw attention to the information written before the tables on the SPDX License List Web page [2]. The FAQ does this for a reason: “This is based on my observation that many people seem to view the webpage at https://spdx.org/licenses/ - and just look at the list (literally) there, skipping over the other information at the top of the page that explains context, bigger picture, etc.” [3] At the moment, the FAQ tries to draw attention to those sections in an awkward and slightly incorrect way [4]. This commit gives those sections anchors so that spdx/license-list-XML#1826 can add direct links to them. [1]: <https://github.com/spdx/license-list-XML/blob/main/DOCS/faq.md> [2]: <https://spdx.org/licenses/> [3]: <spdx/license-list-XML#1809 (comment)> [4]: <spdx/license-list-XML#1809 (comment)>
|
given the other PR, I'm going to close this one. @Jayman2000 - have you joined the mailing list? would be nice to know how you found SPDX/got interested! |
I hadn’t joined before you said that, but I have now.
I’m not sure that it makes sense to post my story on the mailing list, but I will post it here. I develop video games as a hobby. I often end up using assets from OpenGameArt.org with comes with a few different challenges:
I ended up finding REUSE which solved those two problems. From there, I found and got interested in SPDX. |
Before this change, the
DOCS/faq.mdsaid that the License List incorporated the syntax for license expressions. That’s not accurate. The syntax for license expressions is in the SPDX Spec. Also, the link in that bullet point was invalid.