Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More directly draw attention to rest of list #1826

Closed

Conversation

Jayman2000
Copy link
Contributor

@Jayman2000 Jayman2000 commented Feb 12, 2023

Before this change, there was an awkward and slightly incorrect part of the FAQ. It was trying to draw attention to specific parts of the License List Web page that typically get ignored.

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.


This PR depends on another PR. Before this one is merged, the following needs to happen:

  1. Add anchors for the preamble and deprecated id list LicenseListPublisher#154 needs to be finished.
  2. Add anchors for the preamble and deprecated id list LicenseListPublisher#154 needs to be merged.
  3. A new version of the LicenseListPublisher needs to be released.
  4. A commit needs to get added to license-list-XML that makes it use the new version of the LicenseListPublisher.
  5. A new version of the License List needs to be released and published at https://spdx.org/licenses/.

Until those things happen, the links that this PR adds won’t work properly.


This PR is an alternative to #1809.

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)>
Jayman2000 added a commit to Jayman2000/LicenseListPublisher-pr that referenced this pull request Feb 12, 2023
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)>
@swinslow swinslow added this to the 3.21 milestone Feb 12, 2023
@jlovejoy
Copy link
Member

hey @Jayman2000 - thanks for this again... but I still want to keep the list of bullets... we really can't draw enough attention to the larger context in every place possible. Of course, that does mean having to update links in various places, but I think that's better than people skipping this stuff (which they do anyway...)

As to the version number on the main SPDX License List page - when the next release is pushed, that gets updated as part of that. so no added "to-do" for that.

:)

@swinslow
Copy link
Member

Thanks @Jayman2000! I merged #1835 which I think addresses the item you raised here -- thanks for bringing this up and helping to clarify it!

@swinslow swinslow closed this Feb 14, 2023
@swinslow swinslow removed this from the 3.21 milestone Feb 14, 2023
@goneall
Copy link
Member

goneall commented Feb 14, 2023

Just a note - spdx/LicenseListPublisher#154 is already merged. It doesn't look like the new tags will be used, but I'll leave those tags in unless someone wants to create a PR to remove.

Also - I'm having trouble publishing a new version of the app due to some issues with the OSI website - see spdx/LicenseListPublisher#155 for more info

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.

4 participants