21 Commits

Author SHA1 Message Date
chenxing
31526d4c26 doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: I118e4d211617c5df66ff04dc04e308a1d2fc67ad
2019-06-17 23:00:42 +08:00
Mark Goddard
68796d79fa Update contributor guide
... or "what I wish existed when I first became PTL"

Some general improvements to the contributor guide, plus new sections
for PTL duties and release management.

Change-Id: If2f3b7c18de2e6c8d9bac131a16c28c2eeb348f2
2019-06-06 08:59:22 +00:00
ZhongShengping
41f3a817ac Move to opendev
1.Use opendev.org instead of git.openstack.org.
2.Use review.opendev.org instead of review.openstack.org.

You can see the discussion below:
http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html

Change-Id: Ice4509204df788a1a44a06fb89fb44cfe6b54b94
2019-04-23 13:28:39 +08:00
Doug Szumski
205df6949c Add missing steps to Vagrant instructions
Add a couple of missing steps to complete a Vagrant deployment. In
the case of the multi-node deployment we could go one step further
and ensure that the supplied inventory matches the default set of
nodes created by Vagrant.

Change-Id: Iee878e26989e92e4de06c071704a6794011b6e58
2018-11-19 18:23:15 +00:00
chenxing
eaa9815ad2 Remove '.. end' comments
Following by https://review.openstack.org/#/c/605097/
These were used by now-dead tooling. We can remove them.

Change-Id: I0953751044f038a3fdd1acd49b3d2b053ac4bec8
2018-09-28 10:15:37 +08:00
Trinh Nguyen
ce2a50843d Update Ubuntu dependencies of VagrantUp in docs
In Ubuntu 16.04, Vagrant up process requires qemu-utils and qemu-kvm

Change-Id: Idb89f3ace6ada1df2db32579b3f1da289547efa8
2018-07-26 23:27:20 +09:00
confi-surya
dbf754655f Following the new PTI for document build
For compliance with the Project Testing Interface [1]
as described in [2]

[1]
https://governance.openstack.org/tc/reference/project-testing-interface.html
[2]
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

doc8 command is dropped from docs tox envs.
So this affect nothing and run in PEP8.

Related-Bug: #1765348

Depends-On: Icc7fe3a8f9716281de88825e9d5b2fd84de3d00a
Change-Id: Idf9a16111479ccc64004eac9508da575822a3df5
2018-05-21 10:51:59 +01:00
ZhijunWei
d069491148 Update the Bugs link for triage
This content has been moved to [0]

[0]: https://docs.openstack.org/project-team-guide/bugs.html

Change-Id: I1a0bfaa452ed4f29939075a5c80c2bfc056fb3e5
2018-04-30 05:26:25 +00:00
Zuul
f576381ba2 Merge "Trivial: Update pypi url to new url" 2018-04-23 08:59:36 +00:00
huang.zhiping
265046b862 Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: I91815d4e70a6ff8b7da50a528355094239226523
2018-04-23 15:16:08 +08:00
Borne Mace
e751a7cc07 Added support for kolla-cli development
Updated the vagrant dev environment to include support
for development and testing of the kolla-cli

Change-Id: I1d8f66cced7f0a9cc37e3b296c5ae10ab989f736
2018-04-19 14:44:01 -07:00
chenxing
e471549e77 Upgrade the rst convention of the Contributor Guide
We upgrade the rst convention by following Documentation Contributor
Guide[1].

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

Change-Id: I065ceb2f4d455412efeb502e7073e2cb7bc96996
Partially-Implements: blueprint optimize-the-documentation-format
2018-02-08 11:44:21 +00:00
gaofei
3b828fc923 Fix broken link
Merge commit from[1][2]
[1]https://review.openstack.org/#/c/536657/
[2]https://review.openstack.org/#/c/536657/
Change-Id: I79bd4ca2457222abcc6a58cd3b44be21a11b5a87
2018-01-23 06:03:46 +00:00
Surya Prakash Singh
04fd12b945 Restructured the doc of kolla-ansible
Created the admin directory, remove some files from
user dir and placed into admin and contributor.

For more detail, see the doc migration spec.
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: I84c565d7d14a4d90270a53e14ab93a10f7ffb9b7
Partially-Implements: blueprint ka-queens-doc-restructure
2017-10-05 03:23:23 +00:00
Zuul
a19ab77593 Merge "Update the description and links for vagrant" 2017-09-29 04:30:54 +00:00
Jenkins
30c9642d73 Merge "git package added for better automated dev environment" 2017-09-28 07:55:16 +00:00
Surya Prakash Singh
6abbe426b7 git package added for better automated dev environment
On personal experience when i reach to line no 116 with fresh
centos-7.1 it ask to install git package, same has been taken
care in next section for ubuntu-16.04

Change-Id: I688a6ee70d8211740f7d1149ccdfb17183e3a995
2017-09-28 03:02:18 +00:00
caoyuan
8b54520e8a Update the description and links for vagrant
Change-Id: Id6264fa8af55b9da5f8e0cad705287b0c115c7e7
2017-09-27 22:38:11 +08:00
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