mirror of
https://github.com/semver/semver.git
synced 2026-07-10 19:50:47 -05:00
[GH-ISSUE #412] semver/semver needs a wiki. #4550
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: github-starred/semver#4550
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @jwdonahue on GitHub (Nov 28, 2017).
Original GitHub issue: https://github.com/semver/semver/issues/412
Well I already started the wiki page (semi-retired/bored!). I was actually shocked that I had permission to create one, but it's a good sign. I would appreciate it if whoever is currently "in charge" around here would please contact me (joseph@odonahue.com), I'd like to get the wiki page fleshed out with more than just TODO's before EOY. Either take a stab at the TODO's on the wiki page, or contact me with the essential details and I'll crank out some drafts.
Any and all feedback on this issue is welcome and encouraged, I promise to address them in a timely fashion, but I would also like to encourage others to just dive into the wiki if you have the time. If all you do is add reference links to related pages, it will help a lot. I can back-fill the prose after reviewing the linked content.
@jwdonahue commented on GitHub (Nov 30, 2017):
One good use of the Wiki's here at GitHub would be to introduce Engineering Notes. Basically white papers on particular subjects that might provide background for starting new efforts on the site or to flesh out best practices around using SemVer in the real world.
@jwdonahue commented on GitHub (Dec 27, 2017):
Well it appears my wiki attempt has been removed. Closing this issue for now.
@jwdonahue commented on GitHub (Feb 19, 2019):
In light of the new management team, I am reopening this for consideration. We were just starting to evolve a wiki to cover useful bits of info that doesn't belong in issues, when it got pulled. Over the past couple of years, I have found myself answering very similar questions with similar answers. A wiki would allow us to provide detailed and nuanced write-ups on common topics, that can't be covered adequately, or as easily, in the FAQ. We could then reference those wiki pages in responses to issues raised here, and improve the quality and uniformity of support provided. A non-normative media would allow for the kind of subjective exposition that enhances understanding of cold-logical specs.
@steveklabnik commented on GitHub (Feb 19, 2019):
I personally find wikis to to a dumping ground of unmaintianed misinformation. But if the rest of the team wants one, sure.
@jwdonahue commented on GitHub (Feb 20, 2019):
That can definitely happen if we don't keep an eye on it. Another option would be to add a "white-papers" section to the official web site and post a formal process for getting them approved. I'd be willing to contribute.
@segiddins commented on GitHub (Feb 20, 2019):
I agree with steve -- I prefer content be tracked in a git repo, and go through PRs. I personally avoid maintaining wikis whenever possible.
@jwdonahue commented on GitHub (Jan 21, 2020):
As per my own rules regarding the likelihood of getting any traction, I am closing this issue.