3 ms·
How? Badly. Right now it's a GitHub wiki in our "infrastructure" repo (which is basically all the bits and pieces that don't fit anywhere and don't have a prop
by wink 9y ago
How? Badly.
Right now it's a GitHub wiki in our "infrastructure" repo (which is basically all the bits and pieces that don't fit anywhere and don't have a proper repo of their own). We migrated to this from: "several github wikis, each in the repo of the project" - but often you have overlap and it was bad to find stuff.
Pros:
- easy backup (git clone)
- markdown
- easy to get started, "good enough"
Meh:
- searchable only with a browser extension
Contra:
- some coworkers don't like the github wiki
My dream (never happened in any company as of now) would be a single document (think: the manual), hopefully editable in a proper way (I am not sure if checking in changes in a doc/ folder in a code repo is the way to go for <10-20 people) that's hopefully displayable in a browser (and not a PDF, and ESPECIALLY not a Google doc) with cross-references.
- mabbo 9y ago> How? Badly. I was about to make this same joke. Glad to hear that everyone is just as screwed on this.
- dsr_ 9y agogitit is a lightweight wiki that: reads markdown has an online editor available stores in git and is searchable.
- dalemyers 9y agoGood to know that Github wikis aren't searchable. We have a Github Enterprise installation and were considering using the wiki for our longer, detailed documentation, but lack of search is a no go I think.
- JCharante 9y agoYou can search on Github wikis. You enter your query in the search bar to the right of the Github logo. I guess wink hasn't tried to in the past year (https://github.com/blog/2219-search-wiki-pages https://github.com/blog/2219-search-wiki-pages).
- wink 9y agoWow, now that's undiscoverable. Thank you, missed that one completeley Blog post is from August 2016 "You can now search for wiki pages from either the main search page, or within a repository." Guess I made up my mind about that 1-3 years earlier and have used the extension ever since :) Ah well, one click less at least.