Commit Graph

427 Commits

Author SHA1 Message Date
yfzhao
75d6759ce8 Fix wrong links
Some docs links have changed. We should update the wrong links in our codes.

Change-Id: I1b428ee9ca077810cd554e51ea4864294c6a4066
2017-08-11 16:57:03 +08:00
chenxing
421f0b715f Update the usage of openstack-doc-tools
Change-Id: Ib23b36dcace17887874f267b3d51c01190b1cf3f
2017-08-04 11:22:38 +08:00
Andreas Jaeger
f41c6bedfb [contributor] Fix glossary link
The glossary is part of the document, use this instead of a broken link
to the old glossary.

Change-Id: I926ed2a87b7c23f1089b358596444d23bd15b6ea
2017-08-03 13:48:13 +02:00
Jenkins
18bbddc8e5 Merge "address comments in contributor docs" 2017-08-01 10:15:23 +00:00
Doug Hellmann
079714fe21 add has_in_tree_htaccess flag to template generator
Add a flag to tell us which projects have a .htaccess file in their
doc build output.

Change-Id: I0af0e32d9c646d61f4c72599cdc4613299aa5ec9
Depends-On: I236b7b0a9aae065167bd0aef316603d258e4c3c6
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-31 17:21:37 -04:00
Doug Hellmann
1d8e768757 address comments in contributor docs
This patch addresses the comments left on
I9f98c78bc4b13ea64b6cb96537e81b69267905b1 when it was approved.

Change-Id: Ica64f8f1537dbcfbc943b9f478820ac9785279f0
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-31 13:29:02 -04:00
Doug Hellmann
abbd98e952 move docs for template generator into the contributor guide
Move the docs for the template generator input files to the
contributor guide. Expand the docs to explain the template variables
and the data set within the generator code.

Change-Id: I9f98c78bc4b13ea64b6cb96537e81b69267905b1
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-26 17:26:55 -04:00
Doug Hellmann
0529237acf add the documentation for the project data files to the contrib guide
Reformat the plain text file as valid RST, then include it in the
contributor guide instead of just linking to it.

Change-Id: I5992cec2250977c5ec8e809a837bb4404da869ed
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-26 14:53:31 -04:00
Jenkins
622a4370b9 Merge "[install-guide] The guide is version independent" 2017-07-25 08:56:05 +00:00
Andreas Jaeger
75755d3d34 Explain new project specific doc layout
First version of moving some content from the migration spec to the
Contributor Guide to serve as reference on how projects should set up
their directories.

It also explains how to link to the landing pages.

Change-Id: I9c815650a19d6d67d89301fa36d795c590be331d
2017-07-24 14:53:19 +02:00
Andreas Jaeger
9dceacc5f1 [install-guide] The guide is version independent
Remove watermark for pike. This allows to remove sphinxmark extension
usage, so remove it and pillow from test-requirements and update
contributor-guide for this.

Explain that guide handles Pike release now.

Change-Id: Ib1c71971b822cc0aa3e6531b2d5607714551d9db
2017-07-21 21:42:42 +02:00
Andreas Jaeger
50b2fc0b08 [contributor] Update build targets
With the moved content, remove obsolete build targets.

Change-Id: I619ff2f14c452891d16dc6734e2eecf92b1004b1
2017-07-21 20:26:39 +02:00
Doug Hellmann
11baa9130a update instructions for EOL for a series
Change-Id: I7e13d429f3d076e13882797432a8ee569ae90a82
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-21 11:21:48 -04:00
Doug Hellmann
3ef1b62f41 update end-of-release instructions
Update the instructions for managing the end of the release to remove
obsolete steps and to include instructions for setting up the new
templates.

Change-Id: Ifc626faa82e403a04ae18297efc8ec280b9db0ee
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-21 11:21:48 -04:00
Doug Hellmann
0690eb5abd move project-install-guide under /install
Change-Id: I39cabc18e40eee968309b63de3d74e3e828645d9
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-21 11:21:48 -04:00
Doug Hellmann
bfddfc4dc1 move project-deploy-guide.html to /series/deploy
Change-Id: I7b1bbd977cad17a8b1392a499aebb557095a0f40
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-21 11:21:29 -04:00
Doug Hellmann
1fd07e6e31 Remove the user-guide
The useful content in the user guide is all being moved to
project-specific docsets. We can remove the guide here, and replace it
with a /user/ landing page that provides links to all of the known user
guides for services and clients.

Change-Id: I7005b4288b94e755f406fd6a8e3273265b643042
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-14 17:05:46 +02:00
Andreas Jaeger
d245923a32 Fix broken link
This is not a real link, just a reference to the website, just do not
mark it as link.

Currently the link points to
https://docs.openstack.org/contributor-guide/review.openstack.org which
is wrong.

Change-Id: Ic1b4dffdfe15d47dc93713c8f1cf95fbd6097c9c
2017-07-04 22:03:38 +02:00
Doug Hellmann
741b7e3ec0 update contributor guide based on changes after migration project
Update the instructions to indicate which guides are no longer
maintained by the docs team and how those docs are handled instead.

Explain the data input to the www-generator.py tool

Update the release instructions to explain how to update the templated
portion of the site.

Change-Id: I08bb228a6807bfcee0a6ab72ddaf229b455c9d1d
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-03 14:28:59 +00:00
Andreas Jaeger
a1f1748478 Always set bug_project
The openstackdocstheme requires now setting of bug_project, set it up
everywhere.

Change-Id: I778800b8944e3e1d89cdbd1f844c5830a94012d6
Depends-On: Ifd715d1d46d1b1796d79679c9e954d21e9d09455
2017-06-29 22:17:14 +02:00
Jenkins
cc281cac69 Merge "Simplify conf.py for openstackdocstheme 1.11.0" 2017-06-27 09:31:19 +00:00
Andreas Jaeger
b1bad0d43a Simplify conf.py for openstackdocstheme 1.11.0
With the new openstackdocstheme used, we can simplify conf.py.

Also, update our docs for it.

Note that Sphinx 1.6 needs latexmk for building, add it.

Sphinx 1.6 introduces a few new warnings, fix them so that the guides
built.

Change-Id: If2e431725eb54f8be79b9fa4bf9ede2089f321a5
2017-06-27 07:04:30 +02:00
Petr Kovar
5124da252c [contributor] Point to example review for new package release
Change-Id: Id72960b9ded37aa73de07df88a1f58cacf3bc7ce
2017-06-23 09:29:45 +00:00
Jenkins
9c823fb7ab Merge "Fix typo" 2017-06-12 16:17:44 +00:00
Nisha Yadav
d435127e0e Fix typo
Trivial fix correcting spelling mistake
liason-> liaison

Change-Id: I9f1d77a9ea80fb89dba46780c16ed1fe679385a8
2017-06-10 09:00:55 +00:00
Nisha Yadav
688ae19624 Fix typos
Trivial fix
speciality -> specialty
can't -> cannot
it's -> it is
These changes are in accordance to the
contributor-guide which guides to use standard
U.S. English and to avoid using contractions

Change-Id: Icf5616cbe012f166630befab796377ec9b3b9d5e
2017-06-10 00:33:57 +05:30
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