You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
we could "dump" bits of knowledge we gain here and there
all in one place (so that you can access it in one place, you can search it all in one place)
has minimal friction (no rules, no useless processes - you should be able to go quickly from idea to something that's stored)
is accessible to all members of this group
The most obvious choice is GitHub Wiki. However, it is really poor as a "dump", due to its lack of structure (you can't even have nesting unless you manually create it with <ul>s and <li>s, which, eww).
With "traditional" wiki software (especially the SaaS ones), such as confluence, accessibility to the members is also a problem, given the SSO restrictions.
Access gets better with self-hosted solutions (wiki.js, bookstack, outline, etc), but wiki.js' hierarchy system is extremely jarring, bookstack's shelf system means there's a high friction between idea and being able to write it down, and outline has a poor track record as something that can actually be self-hosted, not to mention you need a "bridge" to turn GitHub org membership into OIDC (e.g. dexidp), which is complicated (however, it does nail basically everything else, and the UX is superb).
So if accessibility is a problem, something that resides entirely within github, or more specifically, within github repos - as "code", checked into git - would be more appropriate. For example, there are a lot of SSGs (Static Site Generators) that take contents of a repo, build it into something readable, and then publish it "somewhere" (whether it be GH Pages, Vercel/Netlify, etc).
Of course, the difficulties with this approach is that it is difficult to actually write down something that "just works" - you need to worry about front heading, structures, markdown may not always end up what you think it's going to look like, you need to compose via either github's online interface or your IDE, neither of which is really built for, well, writing words.
So I'm conflicted - clearly, GitHub Wiki ain't it, but if not, then what would be the least worst?
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
-
I want a place where:
The most obvious choice is GitHub Wiki. However, it is really poor as a "dump", due to its lack of structure (you can't even have nesting unless you manually create it with
<ul>
s and<li>
s, which, eww).With "traditional" wiki software (especially the SaaS ones), such as confluence, accessibility to the members is also a problem, given the SSO restrictions.
Access gets better with self-hosted solutions (wiki.js, bookstack, outline, etc), but wiki.js' hierarchy system is extremely jarring, bookstack's shelf system means there's a high friction between idea and being able to write it down, and outline has a poor track record as something that can actually be self-hosted, not to mention you need a "bridge" to turn GitHub org membership into OIDC (e.g. dexidp), which is complicated (however, it does nail basically everything else, and the UX is superb).
So if accessibility is a problem, something that resides entirely within github, or more specifically, within github repos - as "code", checked into git - would be more appropriate. For example, there are a lot of SSGs (Static Site Generators) that take contents of a repo, build it into something readable, and then publish it "somewhere" (whether it be GH Pages, Vercel/Netlify, etc).
Of course, the difficulties with this approach is that it is difficult to actually write down something that "just works" - you need to worry about front heading, structures, markdown may not always end up what you think it's going to look like, you need to compose via either github's online interface or your IDE, neither of which is really built for, well, writing words.
So I'm conflicted - clearly, GitHub Wiki ain't it, but if not, then what would be the least worst?
Beta Was this translation helpful? Give feedback.
All reactions