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

Migrate the README tables and the Late Breaking issue #37

Closed
javagl opened this issue Feb 5, 2020 · 6 comments
Closed

Migrate the README tables and the Late Breaking issue #37

javagl opened this issue Feb 5, 2020 · 6 comments
Assignees

Comments

@javagl
Copy link
Contributor

javagl commented Feb 5, 2020

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 additions to the README that have been done have to be added to the data JSON file. (This may involve some manual work, going through the commit history...)
  • The additions to the Late Breaking issue have to be added (these should only be a few, IIRC)
  • The "Late Breaking" issue should be closed, with a comment pointing to the README of the Project Explorer where the process of adding new entries is explained. (For short: They can be added by opening issues, or also via PRs of the edited data JSON file)
  • The tables in the README should be removed and replaced with a comment and a link to the Project Explorer

The last one raises some issues:

During the call, I mentioned the anchors. For example, people may have existing links like that:

Here are some Python libraries for glTF

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 Explorer


Very roughly speaking, I thought about sneaking anchors into the README like that:

  • A list of anchors that are not visible in the rendered README:

      [](https://github.com/KhronosGroup/glTF/blob/master/README.md#typescript)
      ...
      [](https://github.com/KhronosGroup/glTF/blob/master/README.md#rust)
    
  • Followed by a common pointer to the Project Explorer:

The tables that have been shown here have been replaced with the glTF Project Explorer, at http://github.khronos.org/glTF-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"...:

    [Python](http://github.khronos.org/glTF-Project-Explorer/?language=python)

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...)

@javagl javagl self-assigned this Feb 5, 2020
javagl added a commit to javagl/glTF-Project-Explorer that referenced this issue Apr 8, 2020
Details about the changes will be added as a comment
in KhronosGroup#37
@javagl
Copy link
Contributor Author

javagl commented Apr 8, 2020

This has been addressed in the following branches:

https://github.com/javagl/glTF-Project-Explorer/tree/project-list-migration
https://github.com/javagl/glTF/tree/project-list-migration

The "change log":


Updated glTF-Project-Explorer data file based on the follwing commits
that had been done in the main glTF README.md:

  • Updated link for Archilogic (2019-10-04, 13:22)
  • Updated Esri entries (2019-10-11, 08:55)
  • Added JglTF-mesh (2019-10-24, 17:38)
  • (Adobe Dimension was already up to date (2019-11-06, 17:52))
  • Updated gltfpack, which was formerly called "meshoptimizer" (2019-11-11, 01:44)
  • (Datakit CrossManager was already contained, (2019-11-12, 10:12))
  • (glTFast was already contained, (2019-12-06, 00:39))
  • Updated link for Microsoft.glTF.CPP (2020-01-08, 20:54)
  • (Datakit CrossCad/Ware SDK was already contained, (2020-01-31, 09:19))
  • Added pygltflib (2020-02-01, 09:32)
  • Added Gestaltor (2020-02-29, 15:53)

Updated glTF-Project-Explorer data file based on new entries from
the late-breaking issue:

Updated glTF-Project-Explorer data file based on issue about
broken links (KhronosGroup/glTF#1786)

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

<a id="user-content-optimizers" href="#optimizers"></a>

This way, anchors should keep working, and a link like

https://github.com/javagl/glTF/tree/project-list-migration#converters-importers-and-exporters

should directly jump to the section that links to the project explorer (instead of pointing to the top of the README). For example:

https://github.com/javagl/glTF/tree/project-list-migration#converters-importers-and-exporters

@javagl
Copy link
Contributor Author

javagl commented Apr 8, 2020

(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...)

@weegeekps
Copy link
Contributor

I'm supportive of this, @javagl. Please let me know how I can help.

@javagl
Copy link
Contributor Author

javagl commented Apr 8, 2020

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...)

@javagl
Copy link
Contributor Author

javagl commented Apr 27, 2020

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:

@javagl
Copy link
Contributor Author

javagl commented Jun 24, 2020

Both PRs are merged, therefore closing.

@javagl javagl closed this as completed Jun 24, 2020
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