67 Commits

Author SHA1 Message Date
Andreas Jaeger
c1cc9cae1f Cleanup jobs and config
Use promote jobs for all publishing jobs, they work fine.

We don't use checkbuild/checklang anymore, remove it.

Keep checkbuild job until we have renamed training-guides to use the new
job.

Change-Id: I882fd90f07987358cd55e3a04a8f7ad0c746ce80
2019-08-16 16:19:56 +02:00
Qian Min Chen
4d9996cbad Add release note in README
Change-Id: I905fed3376aaec4180d049881072d6f069449aac
2018-07-17 22:14:41 +08:00
Christian Berendt
558aaf7af5 Fix syntax in README file
"OpenStack Manuals" should be a title.

Change-Id: I0bb337350d71cb00347261f1df2e1bd2f840606f
2018-05-31 11:17:03 +02:00
Petr Kovar
4b4bfa5346 Update Building documentation and README
Point to existing content to avoid duplicity.
More focus on repos other than openstack-manuals.

Change-Id: If24f69279a98ce989e89f85c1183279b7debebec
2018-01-17 21:35:14 +01:00
chenxing
4af6eaf41e Update README file
* remove admin guide from documentation list
* fix format issues

Change-Id: Ib0c2014e1e3c14e49370a4f1a729cf6c263214fb
2017-11-01 15:18:43 +08:00
Andreas Jaeger
c0b41f4ba6 Remove obsolete guides from README.rst
Remove guides that don't exist anymore.

Change-Id: Ie6d2870ecb2dab2a418cbd2b904c44661432eb8f
2017-10-26 13:08:31 +02:00
Andreas Jaeger
eee3c422a2 [contributor] Use linters target
The linters target is new default going forward, update docs.

Change-Id: I69e3f823890e5bedefb3e8af49b64d265234dc1a
2017-10-09 16:44:16 +02:00
Andreas Jaeger
ac477b8f7b Install Guides, not Tutorials
Change all remaining occurences to speak only about Installation Guides.

Change-Id: Ie590d35bd4b68152a64f0a7e2dda6aa0b250a1b1
2017-10-02 13:18:53 +02:00
Alexandra Settle
85107272be [contrib-guide] Updating url to doc-contrib-guide
Based off conversation at the PTG, we agreed it would be
beneficial to ensure the contrib-guide is clearly marked
as the doc contrib guide outside of the title.

This change includes a redirect.

Change-Id: I5abf915f0b94a482afa961e6b86364c26aae5d79
2017-09-22 14:57:47 +00:00
lidong
40abce6fa0 Update links in README
Change the outdated links to the latest links in README

Change-Id: Ic3c320b24edb6fdf46665d76a583f3b3680749b7
2017-08-15 10:08:14 +08:00
Jenkins
66d276db05 Merge "Remove the user-guide" 2017-07-18 14:27:25 +00:00
Emma Foley
eaba852e0d Fixes formatting in README.rst
- Fixes inconsistent formatting on tox command examples
- Fixes broken link for "Getting Latex"
- Fixes bulleted list formatted as a code block
- Fixes literal rendering of ":command:`tox`"

Change-Id: Ie2cc4f890c41da86c613d4bbce34a66017c81c85
Closes-Bug: #1704813
2017-07-17 15:49:20 +00: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
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
Anne Gentle
e83d3baffc Does not build PDF by default with tox -e docs
* Will build PDF by default when using publish though.

Change-Id: I3fc45c4ff657a394316a0bc5d71b2260507b80b3
2017-03-01 20:20:27 +09: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
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
Ian Y. Choi
27b4230489 [README] Explains how to build PDFs
Change-Id: I6c4ff72c69c9a9877a8466fffe1a74a3e820f8d7
Implements: blueprint build-pdf-from-rst-guides
2017-02-21 08:41:53 -05:00
Anne Gentle
fc89f3ebd2 Document how to build from old copies of the openstack-manuals repo
Also minor change to README.rst to not start sentence with a lowercase.

Change-Id: I434948da91e15cbce9feab270372b34ddf8f6a1c
2017-02-09 14:47:55 -06:00
KATO Tomoyuki
108c17a774 Use https instead of http for openstack sites
Change-Id: I85b773045b30b93183ef0daa3bb5afb26d193a08
2017-01-31 07:36:48 +09:00
Anne Gentle
44efc50ac5 Adds new CONTRIBUTING.txt and updates README.rst
* In response to openstack-dev ML thread at
http://lists.openstack.org/pipermail/openstack-dev/2016-December/109294.html
* Proof-of-concept that we would get both a GitHub UI addition of a linked
CONTRIBUTING file as well as a Sphinx include directive in the more detailed
contributor guide.

Change-Id: Ibe4c46faa25697eac4819d8ff1b2722fe58f23bf
2017-01-11 11:47:29 +00:00
Flavio Percoco
e73cf31813 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/326db469cfd3580aa8fe949a671348fd\n'

Change-Id: I28487d4403825604a6c7e298ddf06e2dde4ee5df
2016-11-25 14:45:33 +01:00
KATO Tomoyuki
7494461c72 Cleanup README
Change-Id: I9e1ff4d53ad8aab78a5e99657ec6465868fbae77
2016-10-14 11:16:07 +09:00
wangqi
75fa296d09 just drop the 's' of Installation Guides in README.rst
Change-Id: If5ff51ef3da02c2431af6ab7e33964501237e6ea
2016-06-07 17:14:00 +08:00
Christian Berendt
66375a8ccd Cleanup README file
* remove deprecated tox environments
* remove deprecated Maven instructions
* cleanup syntax

Change-Id: I6b52a658ebd650f8a300a96d4bca200ba7ce687b
2016-05-18 12:22:16 +02:00
venkatamahesh
eecafd59c1 [ha-guide] Changes after ha-guide is merged to manuals
Change-Id: Ibe0a5332405dab784d47d8d507b56a481b4b7602
2016-05-05 21:12:50 +05:30
venkatamahesh
d3eda06967 [README] Add operations guide to list of guides
Change-Id: I0ed95e240e7ba2122ea577992162246f394818de
2016-05-02 10:32:52 +05:30
Jenkins
6e40770c88 Merge "Add 'generated files' section to contributor guide" 2016-04-13 13:51:04 +00:00
Peter Stachowski
1d1a0a8f57 Add 'generated files' section to contributor guide
Instructions for regenerating CLI reference files was
missing from the contributor guide.  This has been
added.  A reference to the document location was
added to the README.rst file.

Change-Id: I4af156ebbd9ddc08c1c80c1ebad6d05203caba91
2016-04-13 12:59:22 +00:00
Jiří Suchomel
2fd6bf3923 Update SUSE versions
Update existing OBS repository locations for openSUSE Leap 42.1
and SLES 12 SP1.

Change-Id: If978ec39dfd2695e570bf73742372b244d6dfa7f
2016-03-17 10:25:48 +01:00
venkatamahesh
5fab4e5bd9 [README] Remove Admin user guide from readme file
Change-Id: I3cc8f27a3b7e3786bb6006cb8441e2dbe575f9f7
2016-04-06 21:18:27 +05:30
venkatamahesh
80d420ee60 [README] Update the name of the guide
Change-Id: I9c7e30b47102652b7046eba47ab1dbf24dd37407
2016-04-02 11:17:09 +05:30
Vikram Hosakote
0878caedd5 openstack-manuals/README.rst has wrong path for
openstack-glossary.pdf.

Fixed the glossary PDF file's path generated by mvn in README.rst.

Change-Id: Id5992a1ce34a74be640c1b33bb610605e8baaadd
Closes-Bug:1544829
2016-02-12 04:17:21 +00:00
KATO Tomoyuki
0b28e35206 Rewrite README for RST guides
At now, all guide are in RST format, except for glossary.
To reflect the situation, rewrite README.
Also, refer contributor guide for details.

Change-Id: If3c6434e582912edf226e3484f289355de632f19
2016-01-16 10:10:32 +09:00
KATO Tomoyuki
1f005801a5 [www] Update the links to Virtual Machine Image Guide
also, update the DocBook example to CLI Reference.

Change-Id: I5e0ac56fa5cc03e0fc79122b59d96af142e5a214
2016-01-06 22:05:57 +09:00
venkatamahesh
e0e9c6a939 Update the documentation contributor guide link
Change-Id: I148e468b97c89a5a01cb9a3246f75e5b3f5b7e25
2015-12-10 14:31:41 +00:00
Xi Yang
7e4c47a579 Update guides in README.rst
The networking guide does not present in the manuals
list in the README.rst. Also, the list contained two
obsolete guides.

Update the list.

Change-Id: I9e48a23f5974ec9218d278b79eeca453a1e5ae2a
2015-11-29 06:35:22 +00:00
Akihiro Motoki
d77dd9bb2e Update RST build instructions in README
Change-Id: I301edb870a16521a1c34f61c0bcd6ba4928306e5
2015-10-17 23:15:47 +09:00
Andreas Jaeger
25d1b7d617 Remove DocBook XML files for Install Guide
Remove DocBook XML files and rename directory from install-guide-rst to
install-guide.

Adjust everything so that publishing works.
Update README to remove DocBook XML Install Guide specific instructions.

Implements: blueprint installguide-liberty
Change-Id: If723c44c3c0383dc8ab8e53798d82e7f0ee2cc57
2015-08-19 16:35:31 +02:00
zhangguoqing
140f9dc81b Modified README about example of build specific guide
Change-Id: I549f3b2a98420b0ffcd92a472f866398c6635556
2015-05-03 15:16:04 +08:00
Andreas Jaeger
245a93598b Update Guides in README
Remove HA Guide, add HOT Guide and HOT reference.

Change-Id: Ic6b9e3880e4bb0812ba99459ac1b789b000cd480
2014-10-29 08:48:25 +01:00
Andreas Jaeger
06f99903e6 Update README.rst
Add more tox environments.

Change-Id: Ie7669d3e7ec9052d4ca987f0ed4d197d04ba6579
2014-10-13 16:42:04 +02:00
Christian Berendt
0d7d095ca1 Explain how to install maven on openSUSE
Change-Id: I5011238e102038198d139ad3620ded2d0eef0e53
2014-09-19 19:03:59 +02:00
Swapnil Kulkarni
2b34c69fe2 Update the yum install maven in README
Maven does not install on "yum install maven3" on Fedora20.
Searching for Maven3 package does not give any results.
The correct way to install Maven3 on Fedora is to
run "yum install maven" instead.
This installs Maven3 and its dependencies.

I think we need to update the documentation with that.

Change-Id: Iaf09e0ba8e293c27eaeb5d5c9b75ea18ab94c9e7
2014-08-12 11:34:17 +00:00
Andreas Jaeger
7d568249d1 Add Architecture Design Guide
Add Architecture Design Guide to various places.

Change-Id: I107ffb941b2abca7b17c0ad80735af4e7b6c4de3
2014-07-22 21:49:02 +02:00
Gauvain Pocentek
04384198f7 Update the list of guides in README.rst
Remove the security and training guides.
Add the CLI and config references.
Sort the list

Remove mention of gating tools.

Change-Id: I5e30d079e934c5c8bf1d57d3fe98fb15178d87ab
2014-07-12 19:58:35 +02:00
Jenkins
6ff20f7c66 Merge "Fixing path" 2014-02-24 15:08:06 +00:00
Jamie Hannaford
fedbd81357 Fixing path
Change-Id: I2407c26ef9ec83a5286f336c83bd2eaa750d0873
2014-02-24 13:24:24 +01:00
Vic Howard
2eab545c0f typos in readme.rst
Attempting to fix some minor typos in the
  readme.rst file.

  Closes-Bug: #1281408

Change-Id: I567c9cede5bb9548e2e87b48eb7f4eec8921953b
2014-02-18 00:11:25 -05:00
Gauvain Pocentek
272f148975 Fix bullet list format in README.rst
Change-Id: I8a6fa088efab2fe501c2d318dbee94ecf047e888
2014-02-02 10:44:49 +01:00