29 Commits

Author SHA1 Message Date
Eduardo Gonzalez
a2125fd326 Fix version name in quickstart guide
Doc says use pike for latest stable branch.
Currently we are in queens

Change-Id: I3983682475b4abf141784c25e117b24cfd38cf29
2018-04-19 08:28:47 +02:00
Zuul
524a522449 Merge "Correct the path of configure file" 2018-04-11 14:49:19 +00:00
caoyuan
5c133c6005 Correct the path of configure file
the path should be "/etc/kolla/globals.yml" rather than
"/etc/kolla/kolla/globals.yml"

Change-Id: I119095bb63fc2af7eb34f16de43ce82f864dd8a4
2018-04-10 23:05:56 +08:00
caoyuan
b9bc5a4132 Add the inventory when use ansible command
when run ansible command, the inventory should be added, or
ansible will use /etc/ansible/hosts by default, but it does't
we wanted.

Change-Id: I7f2a05c27ddfa95d0747abb9ba931ee1c5714dc0
2018-04-10 23:02:17 +08:00
chenxing
e57b4e8c1e Quickstart rewrite
- Add the requirements installation step for development
- Add step number for some section, to make step more clear
- Some format issues fix

Change-Id: I78deee5f4ae424eec06876168cbdfdf8d25d6bcc
2018-04-10 15:48:20 +08:00
huang.zhiping
33a3dfa7b0 fix word in the documentation
Change-Id: Ib47345d54c9cf1077a24b50a358d5e41c0bf696a
2018-03-23 10:00:38 +08:00
chenxing
3a77dba899 Upgrade the rst convention of the User Guide
We upgrade the rst convention by following Documentation Contributor
Guide[1].

[1] https://docs.openstack.org/doc-contrib-guide

Change-Id: Ieceb3942073512fb10670a48d258c4055909496e
Partially-Implements: blueprint optimize-the-documentation-format
2018-03-19 17:13:25 +08:00
zhubingbing
077c85b13f Replace kolla title with kolla-ansible
This is mainly kolla-ansible installation part

Change-Id: Iab14884cfc037bc3cb8055db487c53aa14da070f
2018-02-24 10:09:40 +00:00
caoyuan
b25e8c486b Fix tox -e docs failed
doc/source/user/quickstart.rst:194: D001 Line too long
doc/source/user/quickstart.rst:337: D001 Line too long
doc/source/user/quickstart.rst:339: D001 Line too long

Change-Id: Ibbb3588bddf3bfe9d49c2b2b6909f80c36ec2aff
2018-01-21 21:52:30 +08:00
Michal (inc0) Jastrzebski
742960aa59 Quickstart rewrite
Nearly full rewrite of our QSG to make it more 2017.

Co-Authored-By: chenxing <chason.chan@foxmail.com>
Partially-Implements: blueprint ka-queens-doc-restructure
Change-Id: Ie558e1121438a502611c7c0e6c0e5ac0f6574827
2018-01-17 15:54:33 +08:00
Zuul
e57944b6fe Merge "Don't change directory while running init-runonce" 2017-11-27 07:52:55 +00:00
Zuul
bb032de239 Merge "Remove deprecated version dependencies in quickstart" 2017-11-27 04:53:28 +00:00
Ravi Shekhar Jethani
9c66123c30 Don't change directory while running init-runonce
Currently init-runonce script changes directory to the
script's base directory (/usr/...) before doing anything else.
This unnecessarily _forces_ a non-root user to use sudo for
running this script thereby raising privileges for code which
doesn't want it. Also downloading temporary stuff in places like
/usr... seems not a good choice.

Hence deleting the said code part and letting the deployer work
comfortably from any directory.

Made documentation changes accordingly.

Change-Id: Ib3c7ed97aa5f53c115b6337aaf572b5fdc7a71f3
Closes-Bug: #1732963
2017-11-23 16:35:45 +05:30
Zuul
99c3e2172a Merge "Associate text to link" 2017-11-22 16:35:32 +00:00
chenxing
9ff89025c9 Add the full name of PBR in its first usage
This warning message mentions PBR, but this is the first
instance of this acronym in the documentation. Use the full
name can be made clear what PBR stands for in its first usage.

Change-Id: I46c7db79eb330e7f58d71afd6c749dd27e2c0f80
Closes-Bug: 1729476
2017-11-02 17:28:07 +08:00
Eduardo Gonzalez
e0572969f8 Remove deprecated version dependencies in quickstart
Mitaka and newton are deprecated and no longer maintained
by OpenStack comunity.

Users can check specific documentation for old releases.

Change-Id: I43fd1d40bc2f094fee4c1547879f798a92593df4
2017-10-27 07:38:37 +02:00
chen
d3ba310a52 Associate text to link
The text "Docker Hub Image Registry" is supposed to be assciated with
the link defined at the end of quickstart.rst. This patch ensures that.

Change-Id: I840413520473b1cc3eb7685254d8d133d4c8d497
2017-10-18 17:27:15 +08:00
Surya Prakash Singh
5d162af419 Fixed the Build Container Images link in Quick Start
Change-Id: I2a6ee471b1029bcc2fe1ce76917faf925f1ad239
Closes-Bug: #1723886
2017-10-16 15:36:44 +05:30
Surya Prakash Singh
b36b2463df Quickstart guide updated for better users experience
for reference: https://docs.openstack.org/python-openstackclient/latest/index.html#getting-started

Change-Id: Iacb29585ad89c08de24ea49dfefe7d0d0f5a1815
2017-10-12 09:56:27 +05:30
Jenkins
a03b29829f Merge "Add notes on docker version in quickstart and multinode guide" 2017-10-06 04:36:36 +00:00
chao liu
a5f242e4a2 Add notes on docker version in quickstart and multinode guide
In the quickstart guide, the min version of docker is 1.10.0,
and the max version is none. But the `docker daemon` doesn't work
since v1.13.0. Please refer to:
https://docs.docker.com/engine/deprecated/#docker-daemon-subcommand
"docker daemon subcommand
Deprecated In Release: v1.13.0
Target For Removal In Release: v17.12
The daemon is moved to a separate binary (dockerd), and should
be used instead."
I think it's better to let the readers know it.

Change-Id: I92882a3860704acdc31ff0c89e21ab2793e0b268
2017-10-04 05:33:10 +00:00
chenxing
239946a0df Fix the incorrect content
Change-Id: I138000951d75894cc5eb01a8b364ed8293940c40
Closes-Bug: #1720095
2017-09-29 16:45:30 +08:00
Zuul
9cf89634c6 Merge "Update the "ocata" to "pike" for multinode.html" 2017-09-29 04:33:39 +00:00
caoyuan
618962c216 Update the "ocata" to "pike" for multinode.html
since the pike is release, the multinode.html should update

Change-Id: I5122477b9209cd483ae682032c1949fa5a5cc985
2017-09-28 11:52:32 +00:00
Jenkins
29614fd48d Merge "Fix deploy-guide links" 2017-09-28 01:40:47 +00:00
Surya Prakash Singh
9fad395dce Release tag updated in quickstart guide
Change-Id: I3ee35c6faf2b824d889c4ccadde4d6f8ba9c8cca
2017-09-27 15:02:25 +05:30
Eduardo Gonzalez
197a264a3b Fix deploy-guide links
Deploy guides includes quickstart guide.
Includes respect relative paths, but when
quickstart includes vagrant doc, deploy-guide
tries to locate the doc in its doctree (deploy-guide/source).

This causes error 404 and deploy-guide post-gates to fail

Change-Id: I05e49bbcef564ad4f3d80f0649ccf191d9f8b59d
2017-09-25 13:56:30 +02:00
Andreas Jaeger
67cce63acd Fix quickstart links
Checking http://files.openstack.org/docs-404s/2017-09-08.txt the link
/kolla-ansible/latest/quickstart.html gives a 404 and is most wanted.

The link now is /kolla-ansible/latest/user/quickstart.html - let's
update in tree docs for this.

Fix other broken links as well - with using intra-links instead of
external links - this will make it easier to notice breakage when files
are moved.

Change-Id: I62655afd9f270fa83c07d86aa91346af6337ca32
2017-09-08 18:28:48 +02:00
chenxing
cbd67ebdb1 Rearrange existing documentation to fit the new standard layout
For more detail, see the doc migration spec.
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Co-Authored-By: Eduardo Gonzalez <dabarren@gmail.com>
Change-Id: I3a7c0ed204ee1e9060b5325f20622afe9a5e3040
2017-09-06 17:43:56 +02:00