Support for Visual Studio Team Services

[martinfletcher]

Please can support for Visual Studio Team Services be adsed to Read the Docs? This is the only thing that is stopping us from adopting the platform for our documentation.

If this is already in the pipeline, when is the expected release date for this feature?

[humitos]

This issue is being marked as Community Effort. The core team will try to facilitate resolution with this issue, but without the resources to support external installations outside of our production environment, we must rely on the community to help.

You can read more information on our philosophy around supporting Read the Docs as an open source and volunteer run effort here: http://docs.readthedocs.io/en/latest/open-source-philosophy.html

[humitos]

I'm not sure about the roadmap about this, but I don't think it's on the list right now since RTD is trying to add GitLab since some time ago and because resources are limited is still in review: #1870

[martinfletcher]

If I wanted to start working on this integration, as a contributor - what support could i receive and who would I need to contact to get the ball rolling?

[humitos]

Let's ask @ericholscher and @agjohnson about this.

[agjohnson]

@martinfletcher There would be two pieces, the integration here, and the integration with django-allauth, if it doesn't already exist. We use allauth to provide authentication and oauth capabilities with external APIs. This is probably a good place to start.

After that, there are a number of pieces that RTD needs. #1870 is a mostly complete example here, but that PR has been around long enough that a few things have changed. Our webhook pattern has changed completely and I'm working on a few other pieces that would need to be added with the GitLab and VSTS integrations. Still, this is a good example to base requirements off of.

As for how to get started, I can lay out a ticket that would explain the requirements for development. We can either collaborate there, or IRC is always a good place to get realtime-ish help.

I haven't looked much into VSTS's API capabilities, but I think expanding out to other providers makes a lot of sense. As long as we can create webhooks that would be fired off on commit/other events and can designate private keys through the API, we can likely support the platform. We'd love to have help here, as I've never used VSTS, and it likely wouldn't be on our roadmap anytime soon.

[ericholscher]

My primary question is, what does this support look like? If you only need to build your documentation on commit, you can also do that pretty easily on your own. Ironically our build API isn't well documented, but if that is the only requirement, that might be the shortest path.

[joaobentes]

Hey @agjohnson and @martinfletcher! Is that any progression in that issue? Do you need any help? I'd like to contribute on fixing this issue.

[martinfletcher]

Hi @joaobentes - I have not had much free time in the past 12 months due to projects and moving jobs.

This is still something that i would like to get stuck into though!

@agjohnson for me an issue on GitHub, or a slack channel would be the best means of collaboration. My python skills are a tad rusty, but would be able to gen-up quite quickly, and i know how the VSTS product works very well.

[agjohnson]

We still don't have a lot of resources to allocate to an integration like this. I'm not familiar with VSTS, but as long as you can get an SSH Git URL to a public repository, you can attach this repository to a RTD project. The integration isn't as nice, and isn't one-click setup, but it works. It also requires manual set up of a webhook -- you can set up a generic webhook integration on your RTD project, and point VSTS at this hopefully.

If this is enough, perhaps we just need some documentation on using unsupported providers like VSTS, Visual Studio Online, etc.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.