This repository was archived by the owner on Oct 21, 2022. It is now read-only.
Close docs.lighttable.com ? #10
Description
As the title asks, should we take docs.lighttable.com down and migrate the content into LightTable/LightTable's wiki? I am leaning towards a resounding yes for the following reasons:
- Lack of a maintainer/support
- Yet another area for us to maintain documentation
- More overhead for us
- Github wiki seems like a suitable replacement
- The look and feel is out of date and inconsistent with lighttable.com
A question to ask ourselves is if there are any outstanding reasons to keep it alive and not in a wiki?
@kenny-evitt, @rundis, @cldwalker - thoughts?
Activity
kenny-evitt commentedon Sep 13, 2016
Before we shutdown the subdomain, we need to first change the 'intro' page in LT to not point to this URL.
I think the best thing would be to just pull this into the main repo as a static file.
I don't think we should bother migrating to the wiki. The wiki is open to anyone and I think this, being our only real user documentation, should be maintained by the core team. Anyone could still contribute via PRs, but not just by editing a wiki page. They could, of course, still add wiki pages with info they want to share.
One reason I don't like the wiki, generally, is that anyone can make changes without requiring approval. That makes me anxious as I worry that someone might disseminate misinformation were we to not be closely monitoring it. I'd actually like to move all 'official' info out of the wiki. There is a setting in GitHub for repos – "Restrict editing to users in teams with push access only.". It's currently disabled (un-checked) for the main repo (and probably all of the other repos too). I'd like to enable it but people have been adding info to the wiki and, were I to motivate to work in this area, I'd rather move the docs into LT itself anyways.
rundis commentedon Sep 13, 2016
I share the the worry about using the Wiki for oficial documentation. I can highly recommend gitbook for guide type of documentation. I'd really like to get started on a developers guide and a user guide.
Some examples:
sbauer322 commentedon Sep 14, 2016
I was not aware that pull requests were not supported for Github wikis. In light of this, I would not be opposed to migrating to Gitbook instead. The examples you provided all looked clean and professional. Thank you @rundis!
A developer guide and user guide for Light Table would be extremely useful and related to this existing issue LightTable/LightTable#2056.
@kenny-evitt any thoughts on trying out Gitbook as an alternative for user level documentation?