[openstack-dev] [all][heat] Which repo to use in docs -- git.openstack.org or github.com?
dolph.mathews at gmail.com
Tue Oct 20 18:20:34 UTC 2015
On Tue, Oct 20, 2015 at 12:20 PM, Christopher Aedo <doc at aedo.net> wrote:
> On Tue, Oct 20, 2015 at 3:43 AM, Andreas Jaeger <aj at suse.com> wrote:
> > On 2015-10-20 12:17, Qiming Teng wrote:
> >> Hi,
> >> Just encountered this again in code review . The question is about
> >> the repository to point to when documenting things up. Between the
> >> following links, which one should we use?
> >> - https://git.openstack.org/cgit/openstack/sqlalchemy-migrate
> >> - https://github.com/openstack/sqlalchemy-migrate
> >> I had an impression that I saw something like 'use git.openstack.org
> >> instead of github.com because the later is just a mirror ...' but
> >> find the link now. Maybe it is an illusion. :)
> >> So, seriously, any recommendations or guidelines?
> > Yes, git.openstack.org is our official server, github is just a
> > mirror.
> > Linking to github might also raise the expectation that we use the usual
> > github workflow which is not the case,
> I understand github is a read-only mirror and we don't want casual
> visitors to expect the github workflow - so in most cases I agree
> people should be pointed to our official server.
> On the other hand, the fact that github renders the README nicely
> (including images) leads to a much more inviting first impression.
> For example, for the uninitiated, this git.openstack.org URL
> doesn't help at all if you are curious about the project, while the
> github.com URL tells you what the project is about and even
> includes a few screenshots. For purposes of learning about or
> understanding OpenStack I would say the github.com URL is vastly
+1 I would never direct anyone new straight to git.openstack.org because it
makes a poor first impression relative to github.com. I assume that's the
reason why we keep github.com as a mirror at all (?).
> Is it crazy to suggest we do something similar with our github server?
> : http://git.openstack.org/cgit/openstack/app-catalog-ui/
> : https://github.com/openstack/app-catalog-ui
> > Andreas
> >>  https://review.openstack.org/#/c/237404/
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the OpenStack-dev