-
Notifications
You must be signed in to change notification settings - Fork 47
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
Migrate the README tables and the Late Breaking issue #37
Comments
Details about the changes will be added as a comment in KhronosGroup#37
This has been addressed in the following branches: https://github.com/javagl/glTF-Project-Explorer/tree/project-list-migration The "change log": Updated glTF-Project-Explorer data file based on the follwing commits
Updated glTF-Project-Explorer data file based on new entries from
Updated glTF-Project-Explorer data file based on issue about
For the main glTF README.md:
The point about "anchor links" as also addressed: The README now contains "empty links" in the "glTF Tools" section, like
This way, anchors should keep working, and a link like
should directly jump to the section that links to the project explorer (instead of pointing to the top of the README). For example: |
(If this is OK, I'd create PRs for both projects, but since it covers two projects, any discussion should preferably happen here, in one thread, and not in the individual PRs...) |
I'm supportive of this, @javagl. Please let me know how I can help. |
Thanks @weegeekps The state could already be PR'ed. But one of the main points is whether people are happy with the new ("lean") README, without the tables. (In terms of a further cleanup, one could also pull out things like the "Presentations and Articles" list from the main README into an own .MD. But maybe that's not as critical as the projects list. The latter had been a bit scattered with the README tables, the project explorer and the late-breaking issue - hopefully, this can not converge into a state that is easier to maintain...) |
I have created two PRs
Considering that there are already issues/PRs that might become obsolete, I'd like to avoid diverging too much from the master branches. The information from the following issue/PR have to be considered after merging:
|
Both PRs are merged, therefore closing. |
The data file for the the project explorer has been initialized with the data from the tables in the README and the entries from the "Late Breaking" issue at some point. It has been updated just before the Project Explorer went public. But there have been other additions to the README table and the Late Breaking issue in the meantime.
For the final migration, there are some tasks:
The last one raises some issues:
During the call, I mentioned the anchors. For example, people may have existing links like that:
The link here is
https://github.com/KhronosGroup/glTF/blob/master/README.md#python
, and jumps directly to the "Python" table via the#python
anchor. When the table is removed, the same link will point to the top of the README file. But it should (preferably) jump to the section that originally contained the table, but now only contains the link to the Project ExplorerVery roughly speaking, I thought about sneaking anchors into the README like that:
A list of anchors that are not visible in the rendered README:
Followed by a common pointer to the Project Explorer:
But I'm not sure whether this will work as expected.
@weegeekps I think you even suggested to pass the "anchors" as filter information to the explorer. If I understood this correctly, this would very roughly by done with something like a "query parameter"...:
Is that correct?
This could be a handy functionality anyhow, but I have to clue about how complicated this is (and it's not strictly necessary for the pure replacement of the README tables...)
The text was updated successfully, but these errors were encountered: