Edit documentation in TW and use Github API to create PRs directly?

Community Projects Documentation
#54

OK, I’ve done the test. Well done job.

I have a few suggestion for UI improve:

  • while creating the PR, use a progress bar along with the messages currently generated
  • left column of the table should be less wide. but use em as unit, not px. px is for pictures, em is for text width (the same for default tw setup BTW)
  • right to the “save wiki” icon in the right column of the wiki, would be a very fitting place for a “generate pull request” icon.
  • I’d like to have the system able to generate the list of icon for me, as I edit/create/delete/rename tiddlers and to be able to enable/disable that “pull PR” icon as a result too. I have connected to github before being able to alter things, so I things this should be feasible (this whole paragraph is a suggestion for a later version).

I’m very keen to see this mechanism enabled on the real thing!

#55

A few tweaks. Set column one per em setting. Moved wikify’s closer to targets.

If anything doesn’t look right on your screen, please take a screenshot. Needless to say, everything looks fine on the two screens where I test.

2021-10-29A-Push_PR.json (6.1 KB)

#56

@Mark_S in terms of UI I think this resolves all immediate niggles and issues and feels usable.

It does seem that the path isn’t quite right when using the tiddlers (standard) option for new tiddlers. It results in paths like:
editions/tw5.com/tiddlers/tiddlers/Notes 1.tid when
editions/tw5.com/tiddlers/Notes 1.tid
is expected, see this PR.

Once that is resolved I’ll update the repo with your changes. Thank you for working on this.

#57

See if this works better

2021-10-29B-Push_PR.json (6.1 KB)

#58

That looks good! See new test by saqimtiaz · Pull Request #36 · saqimtiaz/TiddlyWiki5 · GitHub

I will add this to the git repo (which will mean it goes live on the demo) as soon as I get the chance this weekend.

#59

I have added @Mark_S’s changes to the repo and the demo should now be updated with them.

Thank you Mark!

To make a real PR against the main TW repo, change the text of $:/config/sq/makepr/repoOwner to jermolene use the select dropdown in the table to choose “official TW repo”.

#60

When I attempted to submit these items in one batch:

[[ActionCreateTiddlerWidget Example]] [[ActionCreateTiddlerWidget Example 2]] [[ActionCreateTiddlerWidget Example 3]] [[ActionCreateTiddlerWidget Example 4]] [["muritest" by Simon Huber] [["TiddlyServer" by Matt Lauber]] [["Noteself" by Danielo Rodríguez]] [["Encrypt single tiddler plugin" by Danielo Rodriguez]] [["Dynamic Tables" by Jed Carty]]

The form omitted to include two of them: “muritest”, and “TiddlyServer”.

#61

Note the missing closing bracket around the muritest tiddler title, which leads to the two of them being considered as one title, which does not exist.

#62

I have pushed a couple of quick changes:

  • An experiment with tracking new and modified tiddlers and automatically adding them to the PR. image

  • A new optional drag and drop interface instead of the textarea for entering the tiddler titles of tiddlers to include in the PR. Click the button in the top right to revert to a textarea. image

1 Like
#63

The error probably got introduced (Hi! I’m an error!) when dragging and dropping. I found I had to enter the field each time and put a space after each entry or the dragon-drop wouldn’t work on the next one. Hopefully your new drop-box will help avoid this problem.

Thanks!

#64

Note that there seems to be an issue when creating a PR for _canonical_uri tiddlers with this approach, see Add tag Demonstration to related tiddlers by Marxsal · Pull Request #6213 · Jermolene/TiddlyWiki5 · GitHub

Please refrain from doing so until I get the chance to investigate, which may not be until later in the week.

#65

The issue with tiddler types other than text/vnd.tiddlywiki should now be resolved. Note however that it is not possible to edit multids via the wiki (or via node.js).

#66

The demo has been updated with improvements to the instructions and an option to export the tiddlers changed and submitted in the PR, thanks to a PR by @pmario

https://saqimtiaz.github.io/tw5-docs-pr-maker/

2 Likes
#67

I have been contemplating the utility of a wizard that guides new users through setting up their Github access token and making their first PR. However, I am unsure as to how worthwhile the effort would be given that the demo is already very usable but uptake is absent.

#68

Indeed, perhaps we should now link it prominently from tiddlywiki.com?

1 Like
#69

I’m almost finished with my video series. … It took a bit longer than I wanted.
Adding and editing Captions needs way too much time in the youtube web UI

It covers those topics

image
image1920×1080 185 KB

I’m at the last video atm.

4 Likes
#70

Apologies. Tested. Works. Thank you.

Should I send it again now to Official?

#71

We can. Do we want to leave it at its current URL or do we want to deploy it a more official location?

I have been considering packaging it as a Commons plugin and having a Commons repository where it and other Commons plugins live. This would allow others to contribute to it directly (like Mark and Mario) without me being the bottleneck.

Or we could set up a TiddlyWiki Commons organization which could also allow for individual Commons repositories within it. I have not given this part a lot of thought so input is welcome.

It would also be nice to set up a Github action in the Tiddlywiki5 repository that on changes to the tiddlywiki-com branch, triggered an update to the PR mechanism. Currently it is on a timer (cron).

#72

If it is a real PR and not just a test, yes.

Curating or flagging threads
#73

The videos are online: See the Intro thread here at TT: Use TiddlyWiki to Contribute to the TiddlyWiki Documentation

have fun!

1 Like