Plugin documentation

[sean-morris]

I wrote up documentation on the plugin pieces here. It is quite detailed -- maybe too detailed. Please tell me what can be clarified. The PR is off main. I put the documentation in its own file, README-PLUGINSmd. That may not be standard practice so tell me if I should do something different. Good deal.

This addresses Issue #228

[manics]

There's a docs folder that supports reStructuredText and Markdown/Myst:
https://github.com/jupyterhub/nbgitpuller/tree/main/docs

This is published on https://jupyterhub.github.io/nbgitpuller/

[sean-morris]

Thanks for the markdown suggestions; I am getting my markdown education ramped up!

[consideRatio]

Thanks for your patience with review and your work on this @sean-morris!!!

Another tip is that you can do "add suggestions to batch" and then commit multiple detail suggestions as a single commit if you inspect the changes from the "files changed" tab (and only there apparently).

[consideRatio]

These show up again, not part of the documentation PR right?

Btw, I typically do a lot of the following to avoid accidental commits:

• git status - what is the situation?
• git diff - what is changed and unstaged?
• git diff --staged - what am I about to commit?
• git diff HEAD~1..HEAD - what did I commit in the last commit?

Then to correct mistakes I do:

• git rebase -i HEAD~X where X is some numbers of commits to modify up in the history, and I reorder commits, change titles, stop and edits sometimes, squash/fixup etc.
• git commit --amend or git commit --amend --no-edit to modify the latest commit etc

[sean-morris]

yes, this is embarrassing! thanks, I will pull it out. In my first moments of working on this project a bunch of months ago, I worked on the command-line args piece. I made the changes off the master branch of my fork not realizing this would cause me headaches if it didn't merge in quickly.

[consideRatio]

I have a plenty of understanding with the situation @sean-morris, no worries! It is very complicated when any large or several changes are planned at the same time.