← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1742327] Re: Note for instance name at wrong position

 

** Project changed: openstack-manuals => horizon

** Description changed:

- 
  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.
+ - [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. 
+ - [ ] 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
+  - 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

** Changed in: horizon
     Assignee: (unassigned) => Peng, Zhang (zhang-peng)

** Changed in: horizon
       Status: New => In Progress

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Dashboard (Horizon).
https://bugs.launchpad.net/bugs/1742327

Title:
  Note for instance name at wrong position

Status in OpenStack Dashboard (Horizon):
  In Progress

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

To manage notifications about this bug go to:
https://bugs.launchpad.net/horizon/+bug/1742327/+subscriptions


References