Commit Graph

402 Commits

Author SHA1 Message Date
Nisha Yadav
d435127e0e Fix typo
Trivial fix correcting spelling mistake
liason-> liaison

Change-Id: I9f1d77a9ea80fb89dba46780c16ed1fe679385a8
2017-06-10 09:00:55 +00:00
Jenkins
6882a20a07 Merge "Adds a section for cloning the repo first" 2017-05-16 08:47:13 +00:00
Anne Gentle
e8bac0bf62 Adds a section for cloning the repo first
Co-authored-By: Thanhnguyet Vo <tvo@redhat.com>

Change-Id: Ib101c7448932de778e63ca1a93f95191eb3a831f
2017-05-15 21:31:17 +00:00
Anne Gentle
97c6a7a911 Update doc contributor guide for builds
* Add more info about pre-requisites and bindep
* Add info about Windows

Change-Id: Ib4a69594eba71f8fc1e4fa6c8e29a7dcfd53897c
2017-05-15 17:05:57 +00:00
Alexandra Settle
316a4e785d [contrib-guide] Removing specialty team leads
Change-Id: I16ed1eb61988742d4c91027d3b65ba63dea27428
2017-05-02 12:23:33 +00:00
Jenkins
9ba868fc3e Merge "[contrib-guide] Guidelines for docs:follows-policy" 2017-04-27 10:23:45 +00:00
Alexandra Settle
7c99a6f13c [contrib-guide] Guidelines for docs:follows-policy
Adds guidelines for the docs:follows-policy tag.

Change-Id: Ic7c9447ca4c992f645eace08747dd37a71e42218
Depends-on: Id8e2c544856aca712588b7c08e099d16144ad4f3
2017-04-24 10:43:44 +10:00
Farhan Kalsekar
b95490036b [Contributor Guide] Fix typo
Closes-Bug: #1683773

Change-Id: I1fab01eb7f19259d82e7cb025b17c6707051a56c
2017-04-18 14:07:00 +00:00
Colleen Murphy
50e5191704 Fix encoding issues
While this may look like a noop change, it removes an invalid character
that was causing the checkniceness tests to fail. We can also now unpin
the chardet library.

Change-Id: Iaa4e7069187d048ad375376c25b1de4b142b62ad
2017-04-12 17:37:28 +02:00
Jenkins
f077303387 Merge "Update code samples to ocata" 2017-04-07 07:57:15 +00:00
Brian Moss
88365ed25d [contrib-guide] Fix code-block indent
Change-Id: I820ea04b981f5dd779a97a8cb5c6dc067824e89b
2017-04-07 13:17:21 +10:00
Andreas Jaeger
765f9cc24e Update code samples to ocata
Update code samples to use stable/ocata version instead of
stable/newton.

Change-Id: I2cc3df29ab42e6900af5cd0a0327d985cd66dd5d
backport: ocata
2017-04-06 20:39:53 +02:00
Brian Moss
3bb142197e Add link to release README
Add a link to the releases README file that contains
steps for triggering a tools release.

Change-Id: I74beea3d1aed86bb4ad233ce106c55c5f094b52a
2017-04-05 09:50:35 +10:00
Jenkins
65f950715d Merge "[contirb-guide] Jenkins checks and recheck info" 2017-04-04 08:34:52 +00:00
Jenkins
9e9f0545f6 Merge "[contrib-guide] Add auto-config-ref tool instructions" 2017-04-04 00:52:06 +00:00
Olena Logvinova
84c10e0c5a [contirb-guide] Jenkins checks and recheck info
Change-Id: Ic1c8a5815daa54ae35ea6f3b9d884bcb21e08bcf
2017-04-03 17:51:54 +00:00
Alexandra Settle
9fdf6a4a8b [contrib-guide] Add auto-config-ref tool instructions
Change-Id: Ida1dd6388ade5adf18e4aa018f178ef4cff56b33
2017-04-03 16:26:18 +10:00
Lana Brindley
c1de7f7490 Update release instructions
Update instructions to include the need to update links to draft optional
services guides in the basic Install Tutorial.

Change-Id: Ib22d1237e1d82073775929e43df0f35db727b6c7
Partial-Bug: #1677234
2017-04-03 14:28:00 +10:00
Andreas Jaeger
6e245635d1 Reorganize appendix in toc
Move glossary and appendix in one chapter called appendix.

This has been done already for arch-design and ops-guide, do it for the
other guides. Share common appendix.

Change-Id: I6bf4e94f6c0569850cca6558be672de298bb208c
2017-03-31 07:27:29 +02:00
Jenkins
7fb43bf4c8 Merge "Update versions to 15.0 in conf.py" 2017-03-24 06:20:57 +00:00
Ian Y. Choi
fab7780bcf Update versions to 15.0 in conf.py
Version numbers will be used in PDFs such as
"Release Version: 15.0" following short X.Y version.

Note that Ocata is 15th release.

Change-Id: I6a11992e819626f3b4f4360222521795f7e3b74d
2017-03-24 00:26:33 +00:00
Ian Y. Choi
a8b6a9628a Update the end year of copyrights in conf.py
Change-Id: I8cffbff04ad8993d1940d6e27d0d5c7979fa3d71
2017-03-23 06:45:35 -10:00
Brian Moss
240a84d8f4 Update search title
With the change to search.html, the search page now
searches docs.openstack.org, not the specific guide.

Update the header to reflect this.

Change-Id: I9cb4b7669e4c0767e73b105867240a1079d0c086
2017-03-23 12:43:31 +10:00
Alexandra Settle
10ae881a5f [contrib-guide] Updates with a clarification note for deploy teams
Change-Id: Id9a9ef26a9ba91488fd77d36ddb2abce5aace7d4
2017-03-22 15:25:32 +00:00
Jenkins
146681a858 Merge "Adding instructions for rebasing" 2017-03-21 10:10:57 +00:00
Jenkins
ce8a9322b4 Merge "[contrib-guide] Center aligns doc mascot" 2017-03-21 02:00:15 +00:00
Lana Brindley
b8e33d1d6d Adding instructions for rebasing
As per bug, added instructions for manually rebasing a commit.

Change-Id: I59135091b2097c76408da1d086eac8572fe5a826
Closes-Bug: #1673315
2017-03-21 10:56:39 +10:00
Stephen Finucane
478e3f22cc Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate
the setting from the old warnerrors one.

Remove all-files, we do not have man pages.

Note that the build_sphinx section is not used by our toolchain, still
doesn't harm to use proper setup so that it could be used.

Change-Id: I03403b1ed20c4a4bccb1c03311d3999e12a98416
2017-03-16 17:11:23 +00:00
Alexandra Settle
2aa6a39b30 [contrib-guide] Center aligns doc mascot
Requires release of openstackdocstheme with
depends-on commit included.

Change-Id: Ia5ff35287824ec9ddecad6d967fef1b716fc916f
Depends-on: 48a073deaa033997a0bfe263b26188889ecb0d26
2017-03-14 13:53:46 +10:00
Jenkins
5a195649f2 Merge "[contributor] add more details about RST reference" 2017-03-13 03:34:32 +00:00
KATO Tomoyuki
2c8fa4120f [contributor] add more details about RST reference
Change-Id: I4c968cc476b87d38a97bf57a2686d0cb88f7473e
Closes-Bug: #1671068
2017-03-11 07:48:06 +00:00
Jenkins
8d6abac707 Merge "Indicate bindep is for Linux only" 2017-03-10 02:14:17 +00:00
qiaomin
2a080e45c5 Add the missing markups for the hyperlink titles
Change-Id: Ifacff37a9eb560ef392670dd34f827c7da7522a3
2017-03-09 06:36:49 +00:00
Anne Gentle
ef44487101 Indicate bindep is for Linux only
Also adds link to issue tracking for a Mac bindep solution.

Change-Id: Ia7434fd556c510231a8e9e05c9715c13893715c5
2017-03-08 13:43:41 +00:00
qiaomin
0233c6f21b Add the missing markup for the hyperlink title
Change-Id: Ib5af61ec20aabe14c61cb44df59783fa54aca398
2017-03-07 21:48:22 +08:00
RobiJoe
9c1a83e992 Deployment guide procedure update
* This patch adds instructions on how to include
  new deploy guides in jenkins build jobs, based on
  the install-guide content.
* And, it adjusts one title wording for clarity.

Change-Id: Ifcff0f888c95ee66d48115238b9274c03255d235
2017-03-07 17:05:37 +10:00
Jenkins
313bfa73cf Merge "[contrib-guide] Updates team structure" 2017-03-03 17:16:09 +00:00
Alexandra Settle
128dc46a25 [contrib-guide] Updates team structure
Change-Id: Ifd03d76a267c8236b376195fa14846edbbf6a39f
2017-03-03 11:46:42 +00:00
Lana Brindley
70cbbe846f Adding ESL chapter
Adding a chapter for ESL contributors containing advice for non-native
English speakers and for native English speakers, to try and promote
a more inclusive and welcoming docs community. Based on a talk given
by the co-authors at linux.conf.au 2017.

Change-Id: Idd49b332ea20b722095d5b67a3fee465f9f615e9
Co-Authored-By: <masayuki.igawa@gmail.com>
Co-Authored-By: <samueldmq@gmail.com>
Co-Authored-By: <winterma.dong@gmail.com>
2017-03-03 10:51:50 +00:00
KATO Tomoyuki
9818238b02 [www] remove Security Guide landing index page
Change-Id: I4f7af89dfcd3f0661149724601ae889a4e9a153b
2017-03-02 02:44:47 +00:00
Jenkins
3f1b927f60 Merge "[contrib-guide] Updating with bug triage liaison info" 2017-03-01 19:39:26 +00:00
Ian Y. Choi
e99c93418f [contributor] Explains how to build PDF files
PDF builds in openstack-manuals are now supported with --pdf option.
It is a good idea to mention how to build PDF files with
library dependencies.

Change-Id: I40902bb09ee18fda67d6f6cafaf2caf2f05f5c59
Implements: blueprint build-pdf-from-rst-guides
2017-03-01 14:31:50 +00:00
Alexandra Settle
bc80313b5a [contrib-guide] Updating with bug triage liaison info
Also moves docimpact content from wiki to contrib guide

Change-Id: I82cd2165747d8c0ffa1d1011b9f6e8a32cfea861
2017-03-01 11:57:35 +00:00
Jenkins
a72607a976 Merge "Remove Jenkins mention" 2017-02-27 00:05:35 +00:00
Andreas Jaeger
2774316c83 Remove Jenkins mention
OpenStack CI does not use Jenkins anymore, generalize the wording.

Change-Id: I44c2e1f0c2e9f4dc97a553a6706275067bb104f4
2017-02-26 21:44:26 +02:00
Jenkins
f4135e4406 Merge "Add the missing markup for the link title" 2017-02-26 19:16:31 +00:00
Jenkins
f613c23a7e Merge "[Contributor] Add doc logo to front page" 2017-02-26 18:38:22 +00:00
qiaomin
0745264074 Add the missing markup for the link title
Change-Id: Ieea9e6a8757e2b185133be58393b4ca1302f45f6
2017-02-25 16:48:32 +08:00
Andreas Jaeger
780cb054ae [Contributor] Add doc logo to front page
Add the doc logo to the front page of the contributor guide.

Change-Id: Iac2177960350989d873ad96bf8cf94859fef0b89
2017-02-24 20:39:52 +01:00
Andreas Jaeger
b06db69322 Document bindep usage
We use bindep to install our requirements, explain how to use it.

Also, add the bindep tox environment.

See also
https://docs.openstack.org/infra/manual/drivers.html#package-requirements

Change-Id: Ief208e5649223d9d3577ee0a30afdc7db35a86a9
2017-02-24 18:38:46 +00:00