List only built versions on the footer

[stsewd]

When a version is built=False our code links to the version detail page

readthedocs.org/readthedocs/builds/models.py

Lines 296 to 303 in 89a58a0

	if not self.built and not self.uploaded:
	return reverse(
	'project_version_detail',
	kwargs={
	'project_slug': self.project.slug,
	'version_slug': self.slug,
	},

This method gets called from sort_version_aware, here we are passing all active versions (including not built).

readthedocs.org/readthedocs/projects/models.py

Lines 953 to 986 in 89a58a0

	def ordered_active_versions(self, **kwargs):
	"""
	Get all active versions, sorted.
	:param kwargs: All kwargs are passed down to the
	`Version.internal.public` queryset.
	"""
	from readthedocs.builds.models import Version
	kwargs.update(
	{
	'project': self,
	'only_active': True,
	},
	)
	versions = (
	Version.internal.public(**kwargs)
	.select_related(
	'project',
	'project__main_language_project',
	)
	.prefetch_related(
	Prefetch(
	'project__superprojects',
	ProjectRelationship.objects.all().select_related('parent'),
	to_attr='_superprojects',
	),
	Prefetch(
	'project__domains',
	Domain.objects.filter(canonical=True),
	to_attr='_canonical_domains',
	),
	)
	)
	return sort_version_aware(versions)

This is a problem in .com, where we don't have access to that URLCONF, so reverse doesn't work.

I'm thinking two options:

1. Only list built versions, this is modify this method and add a filter (this method is only used in the footer).

readthedocs.org/readthedocs/projects/models.py

Line 953 in 89a58a0

def ordered_active_versions(self, **kwargs):

2. Only change this in .com, adding a new kwarg to .public (only_builts=False)

I'm more inclined to 1, so we affect .org and .com, giving a link to the dashboard to a user that doesn't have permissions doesn't look correct.

[humitos]

Just want to note a use case of this.

Listing "active but not built versions" in the footer is kind of a hidden feature. Why? It allows people to list all the supported versions in the footer and create a Redirect pointing to a different hosting platform for old versions for example.

So, 1.x and 2.x are hosted at Read the Docs, but 0.8.x and 0.9.x are hosted in a different platform. You active=True the fourth of them and create two Redirects for 0.8.x and 0.9.x.

I've used this "hidden feature" for a user already.

[stsewd]

@humitos but when the version is built=False it links to the dashboard, so the redirect doesn't work there.

[ericholscher]

Yea, I think linking to the dashboard doesn't make sense in the context of the footer. I'm happy to update the link to simply go to the docs page, and have it 404 if it isn't built. That enables the redirect logic that @humitos was talking about, and linking the dashboard is not useful for users basically ever when they're in the docs page.