Skip to content

Add contributor how-to: Editing keybindings#586

Merged
mfisher87 merged 10 commits intogeojupyter:mainfrom
mfisher87:contributor-tutorial
Apr 9, 2025
Merged

Add contributor how-to: Editing keybindings#586
mfisher87 merged 10 commits intogeojupyter:mainfrom
mfisher87:contributor-tutorial

Conversation

@mfisher87
Copy link
Member

@mfisher87 mfisher87 commented Apr 1, 2025

Description

Add documentation to help contributors edit keybindings

Checklist

  • PR has a descriptive title and content.
  • PR description contains references to any issues the PR resolves, e.g. Resolves #XXX.
  • PR has one of the labels: documentation, bug, enhancement, feature, maintenance
  • Checks are passing.
    Failing lint checks can be resolved with:
    • pre-commit run --all-files
    • jlpm run lint

📚 Documentation preview: https://jupytergis--586.org.readthedocs.build/en/586/
💡 JupyterLite preview: https://jupytergis--586.org.readthedocs.build/en/586/lite

@mfisher87 mfisher87 added the documentation Improvements or additions to documentation label Apr 1, 2025
@mfisher87 mfisher87 requested a review from arjxn-py April 1, 2025 02:19
@github-actions
Copy link
Contributor

github-actions bot commented Apr 1, 2025

Binder 👈 Launch a Binder on branch mfisher87/jupytergis/contributor-tutorial

### What selector string do I need?

Probably `.data-jgis-keybinding`!
_TODO: What do "selectors" do?_
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would appreciate some input :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The selector field defines which elements the keybinding applies to.
This ensures that the keybinding only applies when a relevant JupyterGIS UI component is in focus.
For JupyterGIS, we typically use:

.data-jgis-keybinding

because we've added this css class to the application shell here.
You'll notice when you click outside JupyterGIS (e.g., on JupyterLab’s top menu), the keybindings will no longer work. However, clicking back inside JupyterGIS will reactivate them.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful, thank you for the extra context :D

@github-actions
Copy link
Contributor

github-actions bot commented Apr 1, 2025

Integration tests report: appsharing.space

@mfisher87 mfisher87 requested a review from martinRenou April 2, 2025 23:49
@arjxn-py
Copy link
Member

arjxn-py commented Apr 3, 2025

I'm rebasing the branch to also trigger CI

@arjxn-py
Copy link
Member

arjxn-py commented Apr 3, 2025

No idea why RTD is failing, however lite ui tests should be fixed after #589 hopefully

@mfisher87
Copy link
Member Author

 looking for now-outdated files... /home/docs/checkouts/readthedocs.org/user_builds/jupytergis/checkouts/586/docs/contributor_guide/index.md:8: WARNING: toctree contains reference to nonexisting document 'contributor_guide/tutorials' [toc.not_readable]
/home/docs/checkouts/readthedocs.org/user_builds/jupytergis/checkouts/586/docs/contributor_guide/tutorials/index.md:3: WARNING: toctree glob pattern '*/*' didn't match any documents
none found
pickling environment... done
/home/docs/checkouts/readthedocs.org/user_builds/jupytergis/checkouts/586/docs/contributor_guide/tutorials/index.md: WARNING: document isn't included in any toctree [toc.not_included]
checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/jupytergis/checkouts/586/docs/contributor_guide/tutorials/keybindings.md: WARNING: document isn't included in any toctree [toc.not_included] 
 /home/docs/checkouts/readthedocs.org/user_builds/jupytergis/checkouts/586/docs/contributor_guide/tutorials/keybindings.md:28: WARNING: Lexing literal_block '  {\n      "command": "jupytergis:identify",\n      "keys": ["I"],\n      "selector": ".data-jgis-keybinding"\n  },\n' as "yaml" resulted in an error at token: ','. Retrying in relaxed mode. [misc.highlighting_failure] 

I'll work on this in a little while :)

```{toctree}
:maxdepth: 1
:titlesonly:
:maxdepth: 2
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't show h2 headings, only show document titles. To a depth of 2.

@mfisher87 mfisher87 changed the title Add contributor tutorial: Editing keybindings Add contributor how-to: Editing keybindings Apr 9, 2025
mfisher87 and others added 10 commits April 8, 2025 20:26
Subdirectory structure will allow us to keep tutorial images (of which
there are likely to be many) alongside their corresponding tutorials.
A how-to is less hands-on and step-by-step than a tutorial, and provides
more context for learners who have more specific needs, i.e. need more
than just an on-rails introduction.
@mfisher87
Copy link
Member Author

Hope y'all don't mind a YOLO merge on these docs PRs. I'd like to make these available to contributors ASAP so we can get feedback from new contributors trying these tasks for the first time.

@mfisher87 mfisher87 merged commit eb02889 into geojupyter:main Apr 9, 2025
23 of 25 checks passed
@mfisher87 mfisher87 deleted the contributor-tutorial branch April 9, 2025 17:09
HaudinFlorence pushed a commit to HaudinFlorence/jupytergis that referenced this pull request Jan 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants