4 ms·

I convinced our BA to use git for internal documentation and meeting notes. VSTS has a similar online text editor for editing and previewing markdown files. I

by styfle 9y ago

I convinced our BA to use git for internal documentation and meeting notes. VSTS has a similar online text editor for editing and previewing markdown files. I have a web hook that builds the markdown using mkdocs so we can have a nice web interface for others who do not have edit privileges. VSTS recently released a wiki feature so I’m considering moving to that instead of mkdocs. I think people see the value in wikis but it’s hard to sell git to someone who hasn’t used it before. I’m always interested in this type of workflow but the problem that no one has seemed to solve is the local editing for a draft document for someone who understands markdown but not git.

bonesss 9y ago
> ...the problem that no one has seemed to solve is the local editing for a draft document for someone who understands markdown but not git. .bat or .sh files? :) A decade ago I was transitioning a small dev shop to Subversion, and daily user #2 was an non-tech accountant who was a few years away from retirement... I didn't teach her branching. I didn't teach her merging. I didn't teach her what a trunk was, or how slicing works. She got two batch files: "Get_Newest" and "Share_Work", and presto-chango she was contributing user documentation and keeping our help-files in order inside our development project. These days, UI competence willing, I'd just install VS Code or Atom with a markdown plugin and point it at the right GitHub repo. With smart branching and repo division I think it's a low-barrier way to get people committing via Git.
jbergens 9y ago
We tried the markdown support in TFS but it was not what we wanted and then we created a small tool using a static site generator. It builds the documentation site after someone pushes new content to the documentation folder. This worked well enough for all devs and some non-devs. I would like to have something like NetlifyCMS but locally stored. https://www.netlifycms.org/ https://www.netlifycms.org/

by styfle 9y ago

bonesss 9y ago

> ...the problem that no one has seemed to solve is the local editing for a draft document for someone who understands markdown but not git. .bat or .sh files? :) A decade ago I was transitioning a small dev shop to Subversion, and daily user #2 was an non-tech accountant who was a few years away from retirement... I didn't teach her branching. I didn't teach her merging. I didn't teach her what a trunk was, or how slicing works. She got two batch files: "Get_Newest" and "Share_Work", and presto-chango she was contributing user documentation and keeping our help-files in order inside our development project. These days, UI competence willing, I'd just install VS Code or Atom with a markdown plugin and point it at the right GitHub repo. With smart branching and repo division I think it's a low-barrier way to get people committing via Git.

jbergens 9y ago

We tried the markdown support in TFS but it was not what we wanted and then we created a small tool using a static site generator. It builds the documentation site after someone pushes new content to the documentation folder. This worked well enough for all devs and some non-devs. I would like to have something like NetlifyCMS but locally stored. https://www.netlifycms.org/ https://www.netlifycms.org/