Documentation should switch "hostname" for actual hostname

Bug #879005 reported by Brian Aker on 2011-10-20
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Core Infrastructure
Triaged
Wishlist
Unassigned

Bug Description

In the Upload documentation, https://review.openstack.org/Documentation/user-upload.html, it talks about "hostname".

It would be nice to replace "hostname" with the actual name of the machine that patches should be uploaded too.

In general, it would be nice if the documentation was customized for Open Stack projects. It is pretty confusing for anyone new to the project.

Brian Aker <email address hidden> writes:

> In the Upload documentation, https://review.openstack.org/Documentation
> /user-upload.html, it talks about "hostname".
>
> It would be nice to replace "hostname" with the actual name of the
> machine that patches should be uploaded too.

Gerrit's documentation is built as static html files at compile time,
and is therefore generic and independent of the host from which it's
served. Changing that is a larger task that's a bit out of scope for
the OpenStack project; you may want to file the suggestion at:

  http://code.google.com/p/gerrit/

> In general, it would be nice if the documentation was customized for
> Open Stack projects. It is pretty confusing for anyone new to the
> project.

We recommend developers follow this OpenStack-specific documentation:

  http://wiki.openstack.org/GerritWorkflow

Which includes the correct details for our project. This should become
even simpler with the adoption of git-review:

  https://github.com/openstack-ci/git-review

-Jim

Monty Taylor (mordred) wrote :

It should be possible to write a patch that could be upstreamed here. I believe an embedded javascript that called a local relative url to get hostname/port information and then replaced the "hostname" entries in the webpage with specifics based on where the gerrit is running should work, and should be upstreamable.

Changed in openstack-ci:
status: New → Triaged
importance: Undecided → Wishlist
tags: added: gerrit
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers