-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Add Opengl documentation (gl4 + gl2.1) #2136
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your work. Please see and address my comments.
lib/docs/scrapers/opengl.rb
Outdated
Copyright 2017-2021 The Khronos Group, Inc.. This work is licensed | ||
under a <a href="http://creativecommons.org/licenses/by/4.0/">Creative | ||
Commons Attribution 4.0 International License</a>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This contradicts the licenses mentioned on https://github.com/KhronosGroup/OpenGL-Refpages#licenses
For historical reasons, the ref pages are under a mix of open source licenses from Khronos, SGI, 3Dlabs, and others. We are unable to change many of those licenses, because the original authors are no longer in business (SGI, 3Dlabs). Ideally we’d like to end up with a Creative Commons license on all the ref pages and Apache 2.0 on all the scripts and tools, but it’s unlikely that will ever be possible.
https://registry.khronos.org/OpenGL-Refpages/gl4/html/barrier.xhtml mentions "Open Publication License", https://registry.khronos.org/OpenGL-Refpages/gl4/html/glBlendColor.xhtml mentions "SGI Free Software B License"
See the lib/docs/scrapers/crystal.rb
scraper how to output different licenses depending on the URL.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have written logic to extract copyright from the page, but I am getting this warning
Docs::AttributionFilter is re-parsing the document.
Unfortunately, I don't think there is any way to do this without parsing the document, as the value changes without any pattern in the URL.
@simon04 I have implemented the requested changes. |
Hi @simon04, Can this be looked into again? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
If you're adding a new scraper, please ensure that you have:
public/icons/your_scraper_name/
directory:16.png
: a 16×16 pixel icon for the doc16@2x.png
: a 32×32 pixel icon for the docSOURCE
: A text file containing the URL to the page the image can be found on or the URL of the original image itself