source-integration icon indicating copy to clipboard operation
source-integration copied to clipboard

Published 20 hours ago • verified publisher icon mantisbt-plugins

Lacks current documentation

Open morgant opened this issue 12 years ago • 13 comments

Source Integration lacks current installation & usage instructions. All the examples from leetcode.net/noswap.com are outdated and now that Source Integration is no longer being actively maintained by @jreese, it seems appropriate to update the README and start pulling documentation into the repository.

morgant avatar Jun 28 '12 16:06 morgant

I'm going to do a rough first pass and will submit a pull request.

morgant avatar Jun 28 '12 16:06 morgant

Thats a great idea. I'll help working on your first pass.

01-Scripts avatar Jun 28 '12 16:06 01-Scripts

That sounds excellent. I'll gladly accept pull requests with proper documentation. :)

amyreese avatar Jun 28 '12 17:06 amyreese

Pull request sent. I suggest next steps would be adding an INSTALLATION.md document covering more detailed config options for the various Source Integration plugins, but this should be a good start.

morgant avatar Jun 28 '12 20:06 morgant

Are all the plug-ins considered to be complete at this point? I really only know the status of SourceGithub, having just updated that one. My understanding of them is:

  • Source: The base plug-in which provides the overall framework.
  • SourceCgit: Git via cgit web interface.
  • SourceGithub: Git via GitHub hosting.
  • SourceSFSVN: SVN via SourceForge hosting.
  • SourceSVN: Local SVN repos via SVN binaries.
  • SourceWebSVN: SVN via WebSVN web interface.

Is that all correct?

morgant avatar Jun 29 '12 16:06 morgant

They're about as complete as they can be at this point. You do have the mappings correct, but there is also a SourceGitweb which provides git via the Gitweb interface.

amyreese avatar Jun 29 '12 16:06 amyreese

Great. (Yeah, had GitWeb in the README in my branch, but missed it when listing it here.) Will submit another pull request shortly.

morgant avatar Jun 29 '12 19:06 morgant

Useful reference for SVN installation http://www.unitz.com/u-notez/2009/10/subversion-svn-integration-mantisbt/

dregad avatar Aug 08 '14 19:08 dregad

I've finally started putting together the plugin-specific configuration documentation (see Pull Request #131 for the SourceGithub documentation).

morgant avatar Jun 12 '15 21:06 morgant

@morgant Do you reckon this should be closed now, or should it remain open to track documentation for other extension plugins ?

dregad avatar Aug 03 '15 14:08 dregad

@dregad I think it should probably remain open pending further documentation.

morgant avatar Aug 03 '15 15:08 morgant

We've installed the plugin and it seems to be working well, but I'm not sure what features it has or how to use it. Documentation covering the basics of that would be great.

samtuke avatar Sep 27 '17 09:09 samtuke

@samtuke I take your point. I'll try and write something up over the next week or so.

bright-tools avatar Sep 27 '17 11:09 bright-tools