SX: Improving the delightful editing process

Cocreation square 💃🕺 Delightful commons
,
#1

However, I think it’s about experience design. Current steps to edit https://delightful.coding.social/delightful-linked-data/

  1. Click on Source Repository
  2. Fork the repository (assuming you already have a codeberg account)
  3. Click on README.md
  4. Click on edit
  5. make changes
  6. Click on “code”
  7. Click on the “new pull request” button
  8. Click on "new pull request"

This is HARD!

It would be nice if one could reduce this to the stuff in bold.

I’m convinced it would not be terribly hard to reduce the number of steps needed here.

1 Like
#2

:100: Agree! Code forges generally offer dev-only UI for editing. It is not intuitive to other SX stakeholders.

It would be great. You had some good recent experience with the FEP site. I am curious if this can be done with the site still being hosted by Codeberg Pages, though I think that should be possible here.

#3

Note that, though it hasn’t been tested, the Delightful commons initiative should accept curated lists that are hosted and maintained on other forges, accessed based on their git URL. Codeberg isn’t a requirement.

#4

As long as you can have a link to the username on Codeberg (because the source code is generated from the repo hosted there) it is doable using their APIs.

While working on Anvil I had touch points to half of the relevant APIs Forgejo exposes to achieve this.

2 Likes
#5

I am okay with the constraint of “Delightful lists must be hosted on Codeberg” if the editing facility makes it plain easy for anyone to suggest updates for review by list maintainers. Then “hosting elsewhere” can be a concern when the need actually arises.

#6

Just some nitpicking:

  • A codeberg specific solution would be kind of horrible
  • A forgejo specific solution would be ok. I mean https://codeberg.org/api/swagger leads to a HTML page with title “forgejo API” for a reason

Second relating on how hard this is:

  • You will probably want to do some OAuth with codeberg for creating the fork people can edit in. This is “easy standard stuff”. It still involves work.
  • So if you want a vanilla js solution, you would first need to figure out if there is some lib that does that for you.
  • I just tried. I’m unhappy.
1 Like
#7

Today I deployed an update to https://fedi.builders/

Commit https://code.jaenis.ch/andre/jaenis.ch_design-system/commit/913377acdda9f4e4e98441fbc90584adf67345b6 (NginX is responding with 403 because I don’t want to run an Anubis/go-away here while also fending off bots. You can clone andre/jaenis.ch_design-system: My design system that documents everything from markup over styling to architectural decisions. - Forgejo: Beyond coding. We forge. if you’re curious - licensed under AGPL 3)

With this the steps reduce to:

  1. Login with Codeberg credentials (Web Component is designed to accept other Forgejo instances)
  2. Wait a few seconds for the README to load (Web Component is designed to accept arbitrary repos and filepaths therein)
  3. Make your edits
  4. Click „Submit changes”

There are a few cases I haven’t handled yet (branch exists, insufficient permissions and similar) but the happy case works. I could also load a full-fledged Richt Text Editor or show a live preview and comparison if I wanted.

A reduction compared to your outline at least:

1 Like
#8

Managed to get the documentation deployed: storybook - Storybook

Feedback welcome (here, on Matrix @andre:matrix.org or the fediverse: @andre@fedi.jaenis.ch – the latter one is on allowlist mode).

1 Like
#9

@Ryuno-Ki absolutely super that you got to experimenting so quickly! Did not have time to check things out yet, though. :grimacing:

There’s an old open PR by @Mediaformat on delightful-fediverse-development proposing a PR template to be configured for that list. I never got around to incorporate it further. :flushed:

Showing a template this way might not be the best option in light of the above, but when editing a list esp. adding new resources there are…

  • General guidelines for delightful lists to take into account.
  • Specific preferences the list maintainers have wrt to the list’s layout.

…which people should be somehow informed about.

#10

First, thanks for putting in the effort. :+1:

It’s just, I dislike things that make me enter a password. OAuth is necessary here.

1 Like
#11

Okay. Going to look into OAuth then. Can be an alternative to credentials entered directly.

1 Like