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

[GEOT-7473] Update or remove API diagrams #4521

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jodygarnett
Copy link
Member

@jodygarnett jodygarnett commented Oct 12, 2023

GEOT-7473 Powered by Pull Request Badge

This is a non functional change to documentation.

Checklist

For core and extension modules:

  • New unit tests have been added covering the changes.
  • Documentation has been updated (if change is visible to end users).
  • There is an issue in GeoTools Jira (except for changes not visible to end users).
  • Commit message(s) must be in the form [GEOT-XYZW] Title of the Jira ticket.
  • Bug fixes and small new features are presented as a single commit.
  • The commit targets a single objective (if multiple focuses cannot be avoided, each one is in its own commit, and has a separate ticket describing it).

@aaime
Copy link
Member

aaime commented Oct 16, 2023

Looks like legit doc build failures:

2023-10-13T01:21:18.4884344Z      [echo] Running sphinx-build -D release=31-SNAPSHOT -q -W --keep-going -j auto -b html -d "/home/runner/work/geotools/geotools/docs/target/user/doctrees" . "/home/runner/work/geotools/geotools/docs/target/user/html"
2023-10-13T01:21:24.1086048Z      [exec] /home/runner/work/geotools/geotools/docs/user/tutorial/feature/csv2shp.rst:316: WARNING: image file not readable: tutorial/feature/images/Feature.png
2023-10-13T01:21:24.1089072Z      [exec] /home/runner/work/geotools/geotools/docs/user/library/main/datastore.rst:147: WARNING: image file not readable: images/DataAccess.png
2023-10-13T01:21:24.1091715Z      [exec] /home/runner/work/geotools/geotools/docs/user/library/main/datastore.rst:194: WARNING: image file not readable: images/SimpleFeatureSource.PNG
2023-10-13T01:21:24.1094454Z      [exec] /home/runner/work/geotools/geotools/docs/user/library/main/datastore.rst:359: WARNING: image file not readable: images/SimpleFeatureStore.PNG
2023-10-13T01:21:24.1097165Z      [exec] /home/runner/work/geotools/geotools/docs/user/library/main/datastore.rst:419: WARNING: image file not readable: images/SimpleFeatureLocking.PNG

Seems case sensitivity issue in file names (to be more precise, in the extensions)?
(is file.PNG looking weird for me only?)

Copy link

stale bot commented Jan 14, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jan 14, 2024
Copy link

stale bot commented Jan 28, 2024

This issue has been automatically closed because it has not had recent activity. Please re-submit with updates if you want to resume work on this topic. Thank you for your contributions.

@stale stale bot closed this Jan 28, 2024
@jodygarnett jodygarnett reopened this Jan 28, 2024
@stale stale bot removed the stale label Jan 28, 2024
@jodygarnett
Copy link
Member Author

This is technical debt from the API migration; I am a bit sad this activity was not "fully funded" and has left cleanup work behind.

I wonder if it is better to just remove outdated diagrams, this would be a good SoC student activity.

Copy link

stale bot commented May 31, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label May 31, 2024
@jodygarnett
Copy link
Member Author

Yeah I don’t know how to update diagrams without a geotools workshop planned

@stale stale bot removed the stale label May 31, 2024
@aaime
Copy link
Member

aaime commented May 31, 2024

Every time you comment on an issue the stale bot resets and it busy more time for the PR. But why keep a stale PR open for so long, what's the point? Is should be clear the work at hand does not match your priorities and available time by now...

@jodygarnett
Copy link
Member Author

So I am left with a value judgement; better to remove the diagrams (something I can do now) or leave in correct (but perhaps helpful guidance).

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