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

Add Opengl documentation (gl4 + gl2.1) #2136

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Suraj-Yadav
Copy link

@Suraj-Yadav Suraj-Yadav commented Jan 21, 2024

If you're adding a new scraper, please ensure that you have:

  • Tested the scraper on a local copy of DevDocs
  • Ensured that the docs are styled similarly to other docs on DevDocs
  • Added these files to the public/icons/your_scraper_name/ directory:
    • 16.png: a 16×16 pixel icon for the doc
    • [email protected]: a 32×32 pixel icon for the doc
    • SOURCE: A text file containing the URL to the page the image can be found on or the URL of the original image itself

image

@Suraj-Yadav Suraj-Yadav requested a review from a team as a code owner January 21, 2024 01:45
Copy link
Contributor

@simon04 simon04 left a 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 Show resolved Hide resolved
Comment on lines 14 to 16
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>.
Copy link
Contributor

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.

Copy link
Author

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.

lib/docs/scrapers/opengl.rb Outdated Show resolved Hide resolved
@Suraj-Yadav
Copy link
Author

@simon04 I have implemented the requested changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants