#10 Update Contributing document to cover online editing
Merged by jflory7. Opened by ferdnyc.
fedora-docs/ ferdnyc/documentation-contributors-guide contributing-online  into  master

Download 10.patch

The Contributing doc previously contained a NOTE admonition box about a 'planned' "Edit this Content" button. Since that button exists, I removed the admonition, and instead updated (rewrote, kind of) the page — and the Prerequisites, as a side-effect — to also cover online editing directly in Pagure.

I certainly don't expect such a large change will necessarily be adopted wholesale. So consider this PR as initiating discussion regarding the edit process and how it should be presented, more than a request to merge.
Given that said discussion has been had, and the commentary addressed, this now is a request to merge.

#TIL that strike tags do not work in Pagure comments.

It is my preference, but I would rather drop the two last sentences of this line and link out instead to a guide like this one on writing good git commit messages. It is covered in more detail with explanations in the blog post.

Hey @ferdnyc, thanks for your patience on this pull request. This looks almost ready to merge to me.

I have one request, could you please write each sentence on its own line per the AsciiDoc recommended practices? It will make future edits to this doc easier to review for maintainers.

Thanks for your time on improving the Fedora Docs!

Metadata Update from @jflory7:
- Request assigned

It is my preference, but I would rather drop the two last sentences of this line and link out instead to a guide like this one on writing good git commit messages. It is covered in more detail with explanations in the blog post.

Fair enough, though one of those two sentences is

The suggested title, "Update pathname", is sufficient for small edits.

and I do feel compelled to point out that since it's our suggested title, that particular aspect won't be addressed in any external guide. :wink:

(Of course, the fact that it's provided as a suggestion arguably means it doesn't need to be addressed at all. But my intention there was less about the suggested message than about implicitly pointing out that it's not sufficient for all commits. My worry, with suggested titles, is always about the possibility of someone getting the impression that a 50-line document overhaul should be submitted as "Updated pathname". But, maybe I'm underestimating people.)

I have one request, could you please write each sentence on its own line per the AsciiDoc recommended practices? It will make future edits to this doc easier to review for maintainers.

Sure, I'll reformat and push a new commit.

1 new commit added

  • Reformat sentence-per-line

I have one request, could you please write each sentence on its own line per the AsciiDoc recommended practices? It will make future edits to this doc easier to review for maintainers.

Sure, I'll reformat and push a new commit.

Done. I just rewrapped the whole thing, even the parts I didn't edit.

Haven't addressed the Git advice yet, this change was easy enough to automate so I wanted to apply it quickly. But I'm gonna hold off addressing content issue(s) for now, just until I can spend a bit more time.

1 new commit added

  • Rewrite git tips admonition

@jflory7

OK, I trimmed down both the second and third bullet points of the tips box, and added a link to Tim Pope's commit.style single-page site. It's a lot less detailed than many other such guides, but it's also a lot shorter.

I did keep the "...suggested title..." sentence, but I dropped the one before it instead. Anyway, take a look and see what you think now. I'm happy to make further changes if need be.

1 new commit added

  • Format Prerequisites sentence-per-line

@jflory7 (or anyone), are any further changes still needed on this?

rebased onto 30a587387d0f639c7b66d98e76232c33bc17fc09

I stumbled back on this after a long time. I missed the follow-ups around January during holiday catch-up. I rebased and the PR is still a clean merge. I'm going to go ahead and merge this. Thank you for your patience and time @ferdnyc!

Pull-Request has been merged by jflory7

Metadata Update from @jflory7:
- Pull-request tagged with: type - new docs

Thanks @jflory7 !

Funny you should bring this up, just the other day I discovered that the "Edit this page" links on Docs pages are actually only visible when the browser width is greater than 1024px, which is kind of unfortunate since there's no mention of that in my discussion of them here.

Now I have to decide whether I should submit a PR updating this doc to address that limitation, or file it as a bug since it doesn't really make sense (IMHO, not to mention seems awfully arbitrary) that we'd restrict page editing to users with > 1024px-wide browser windows.

@ferdnyc Maybe it would be something that could be addressed in the site theme. Maybe @ryanlerch, @pbokoc, or @asamalik know more.

Yeah, that's something we need to fix in the UI bundle. I made a separate issue there: https://pagure.io/fedora-docs/fedora-docs-ui/issue/9

Oops, thanks @pbokoc . Guess I should've checked here first, before filing https://pagure.io/fedora-docs/docs-fp-o/issue/148 in the wrong place. :laughing:

I'll close that issue, and move my screenshots over to yours.

Metadata