Note for instance name at wrong position

Bug #1742327 reported by Peng, Zhang
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Dashboard (Horizon)
Fix Released
Undecided
Akihiro Motoki

Bug Description

This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:

- [x] This doc is inaccurate in this way:
Note message for section "instance name" is now located after section "Availability Zone" which makes users feel confused:

In current horizon user document:

================================================================================
   Instance Name
      Assign a name to the virtual machine.

   Availability Zone
      By default, this value is set to the availability zone given by the
      cloud provider (for example, ``us-west`` or ``apac-south``). For some
      cases, it could be ``nova``.

      .. note::

         The name you assign here becomes the initial host name of the server.
         If the name is longer than 63 characters, the Compute service
         truncates it automatically to ensure dnsmasq works correctly.

         After the server is built, if you change the server name in the API
         or change the host name directly, the names are not updated in the
         dashboard.

         Server names are not guaranteed to be unique when created so you
         could have two instances with the same host name.
===============================================================================

The above contents should be like follows:

================================================================================
   Instance Name
      Assign a name to the virtual machine.

      .. note::

         The name you assign here becomes the initial host name of the server.
         If the name is longer than 63 characters, the Compute service
         truncates it automatically to ensure dnsmasq works correctly.

         After the server is built, if you change the server name in the API
         or change the host name directly, the names are not updated in the
         dashboard.

         Server names are not guaranteed to be unique when created so you
         could have two instances with the same host name.

   Availability Zone
      By default, this value is set to the availability zone given by the
      cloud provider (for example, ``us-west`` or ``apac-south``). For some
      cases, it could be ``nova``.

===============================================================================

- [ ] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.

If you have a troubleshooting or support issue, use the following resources:

 - Ask OpenStack: http://ask.openstack.org
 - The mailing list: http://lists.openstack.org
 - IRC: 'openstack' channel on Freenode

-----------------------------------
Release: 13.0.0.0b3.dev125 on 2018-01-09 04:20
SHA: 091121b10ff2090ec4bce7c4f5436c9ade3a790d
Source: https://git.openstack.org/cgit/openstack/horizon/tree/doc/source/user/launch-instances.rst
URL: https://docs.openstack.org/horizon/latest/user/launch-instances.html

Peng, Zhang (zhang-peng)
affects: horizon → openstack-manuals
Peng, Zhang (zhang-peng)
affects: openstack-manuals → horizon
description: updated
Changed in horizon:
assignee: nobody → Peng, Zhang (zhang-peng)
Peng, Zhang (zhang-peng)
Changed in horizon:
status: New → In Progress
Akihiro Motoki (amotoki)
Changed in horizon:
milestone: none → queens-3
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to horizon (master)

Fix proposed to branch: master
Review: https://review.openstack.org/536028

Changed in horizon:
assignee: Peng, Zhang (zhang-peng) → Akihiro Motoki (amotoki)
Revision history for this message
Akihiro Motoki (amotoki) wrote :

Oh.... sorry. I didn't notice you are assigned to the bug.

Revision history for this message
Peng, Zhang (zhang-peng) wrote :

@Akihiro:
Never Mind :)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to horizon (master)

Reviewed: https://review.openstack.org/536028
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=869127ec19fd4e3abdeeacbeb312e3bfaeb07a0d
Submitter: Zuul
Branch: master

commit 869127ec19fd4e3abdeeacbeb312e3bfaeb07a0d
Author: Akihiro Motoki <email address hidden>
Date: Sat Jan 20 17:47:39 2018 +0900

    doc: Move the note to an appropriate place

    "Description" field is also added to match the current version.

    Change-Id: Ia05d1873d69500b9e2c576fcb8abe9dbdeba25e8
    Closes-Bug: #1742327

Changed in horizon:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/horizon 13.0.0.0rc1

This issue was fixed in the openstack/horizon 13.0.0.0rc1 release candidate.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.