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

Question: sync with official refpages? #119

Open
imirkin opened this issue Mar 27, 2022 · 6 comments
Open

Question: sync with official refpages? #119

imirkin opened this issue Mar 27, 2022 · 6 comments

Comments

@imirkin
Copy link

imirkin commented Mar 27, 2022

I've pushed some changes to the https://github.com/KhronosGroup/OpenGL-Refpages repository, which are obviously not reflected here.

And I'm seeing a lot of small fixes in this repo which are likely not reflected in the official refpages.

Are there any thoughts on keeping the two in sync somehow?

@BSVino
Copy link
Owner

BSVino commented Mar 28, 2022

I would absolutely love and definitely merge any PR containing changes from the official that haven't made their way here yet. Good job on the reverse direction PR that you did.

@imirkin
Copy link
Author

imirkin commented Mar 28, 2022

So what I was wondering was whether you thought it'd be practical to have an automated process consuming the OpenGL-Refpages data directly. It could be a separate tree so that you could still control the content in case of disagreement(/slowness) with the Khronos maintainers, but at least it'd be in a shared format.

I haven't really dug into the guts of the more structural docs.gl changes -- I was hoping you could perhaps opine on whether such a strategy could work, and/or suggest a way forward?

@BSVino
Copy link
Owner

BSVino commented Mar 28, 2022

From a technical perspective, I completely removed the header and footer of all of the pages. The diff algorithm might get confused by that but would probably be fine. But realistically, I think it would require a manual merge to get everything up to date before an automated process could hope to work ok, and I'm not sure the frequency of changes on the kronos documents merits the amount of work it'll take to set up something automated. Maybe if it's super easy for someone?

@imirkin
Copy link
Author

imirkin commented Mar 28, 2022

OK, so stuff like examples/etc are all "outside" of the main .xhtml content data? I thought there were special tags/etc that were inserted, but perhaps that's done "later". If it's literally just the headers/footers, should be rather simple.

@imirkin
Copy link
Author

imirkin commented Mar 28, 2022

Also, it's not so much about frequency of updates, but having a single spot where to make the updates, to avoid divergence as much as possible.

@BSVino
Copy link
Owner

BSVino commented Mar 29, 2022

Yes those are done outside, mostly, if I remember.

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

No branches or pull requests

2 participants