Lacks current documentation

mantisbt-plugins / source-integration

Source control integration plugin framework for MantisBT, including support for Github, Gitlab, Bitbucket, Gitea, Gitweb, Cgit, Subversion, Mercurial and more

http://noswap.com/projects/source-integration/

MIT License

181 stars 130 forks source link

Lacks current documentation #18

Open morgant opened 12 years ago

morgant commented 12 years ago

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 commented 12 years ago

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

01-Scripts commented 12 years ago

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

amyreese commented 12 years ago

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

morgant commented 12 years ago

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 commented 12 years ago

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?

amyreese commented 12 years ago

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.

morgant commented 12 years ago

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

dregad commented 10 years ago

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

morgant commented 9 years ago

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

dregad commented 9 years ago

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

morgant commented 9 years ago

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

samtuke commented 7 years ago

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.

bright-tools commented 7 years ago

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