Commit Graph

83 Commits

Author SHA1 Message Date
jacky06 ffa50302f2 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I1fa55fdb52f2a74e01c28268dd3973e3151ef7e3
Closes-Bug: #1825923
2019-04-23 03:16:36 +00:00
melissaml 15fe203715 Update links in README
Change the outdated links to the latest links in README

Change-Id: I1f840669bade015e53657cd9f7f553892c0591cc
2018-03-03 13:04:13 +08:00
Stephen Finucane d3c952064a Remove 'autogenerate_config_docs'
This tool has been superseded by the 'oslo_config.sphinxext' Sphinx
extension and can finally be put to rest.

[1] https://docs.openstack.org/oslo.config/latest/reference/sphinxext.html

Change-Id: Idae5ba656c3a0da8a26c6f1e63332365c8012c0b
2017-10-04 11:47:56 +01:00
Brian Moss d3bc42483a Update sitemap tests
- add py3 to tox.ini (gate already tests py3)
- move all tests to $GITROOT/test so they can all run
  through testr
- add scrapy to test-requirements.txt to support sitemap tests
- move tests from test_items.py to test_sitemap_file.py
- fix broken sitemap tests
- add newton to list of old releases in sitemap_file.py
- ignore flake8 H101 as it returns false positives for Sphinx conf.py
- Use openstackdocstheme for docs
- Update sitemap README
- Restructure repo docs
- fix minor style issues

Change-Id: I22c018149b2eefde6ca5c38c22ac06886fe9a7a8
2017-04-29 10:36:27 +10:00
Anne Gentle 59204ff6f8 Update to point to launchpad openstack-doc-tools
Change-Id: Ic17e9ae894897d3a588edb693a72b1cab0d2a369
2017-02-14 19:19:44 -06:00
Jenkins 45cae63e02 Merge "Show team and repo badges on README" 2016-12-09 18:20:27 +00:00
Flavio Percoco 3a7426ef25 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/9a0f7bcf2ea57d7c87651330c4a18ec1\n'

Change-Id: I0190e086f8eb1b19c07beb27387f87ba8e9e20db
2016-12-09 18:17:19 +00:00
Petr Kovar 59542bc572 [config-ref] Update README for RHEL/CentOS; diff_branches for Ocata
Change-Id: I3ec93b1fad946de21e2bbb7a4386edaee1267d27
2016-11-30 19:47:02 +01:00
Jenkins afd3120946 Merge "Gen autogenerate_config_docs/README.rst" 2016-11-21 07:24:02 +00:00
Brian Moss 98247bbf80 Link to Contributor Guide instead of wiki
Change-Id: Ib03ea8c58bc33df3f691118ca1462a6d220770d4
2016-11-21 12:25:18 +10:00
Alexis Lee 3f8ed82319 Gen autogenerate_config_docs/README.rst
Link from index and main README.

Change-Id: Iad0a72544eb4849f0823029d6f7523e421ddc9e0
2016-11-15 13:29:20 +00:00
Luong Anh Tuan 1dadc93e75 Add prefix "$" for command examples
Change-Id: I62d147e4451cd5a7b3dd11fe70ecf84c2e94b23a
2016-10-19 11:22:22 +07:00
Andreas Jaeger fe586291ff Remove openstack-doc-test
openstack-doc-test is used for building of DocBook XML files. For index
page generation openstack-indexpage can be used.

Remove openstack-doc-test together with all support files.

Change-Id: I5589bc634e1f630f79b3d6e8bffee939c5300bf2
2016-05-19 01:51:03 +00:00
venkatamahesh 7e86aa8686 [README] Update the content for mitaka
Change-Id: I9b03356f02f88f681b4b4b61fe12965896559279
2016-04-06 17:06:03 +05:30
Doug Hellmann 072fc1d619 Fix up README to work with the release tools
Add links to the bug tracker and source in a way the release script can
find them.

Move the contributing instructions to a separate file, where github will
pick them up and the release tools won't be confused by the urls.

Change-Id: Icbc1fdde3245ef6aa750bd44601adb1514763034
2015-06-19 13:23:52 +00:00
Jeremy Stanley 49d4c6d2ed Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: Ib947ebfc78ed80447d0b3b8895d9e96919fb1b00
2014-12-05 03:30:37 +00:00
Chandan Kumar 842c98c4f7 Added dependencies for lxml on Fedora
Change-Id: I59df32c7527e83578b56f4e0c73be441b33610f9
2014-10-30 13:53:24 +05:30
Chandan Kumar 94a0bd3182 Fixed the command to install maven on Fedora
Change-Id: If23d94fc0448944855ee58882a7386379f97e5b7
2014-10-29 20:39:03 +05:30
Christian Berendt 9a1b2e1731 Move release notes into a separate file
Change-Id: I179e3b304f63fa2c9b513c08087532aab9ef2112
2014-07-28 22:04:02 +02:00
Gauvain Pocentek 6958e7aaed README update for the 0.17 release
Change-Id: I57ece965c9227f923ace03650e9cb9e33a5f8ee2
2014-07-27 20:46:59 +02:00
Jenkins e733890121 Merge "Provide openstack-dn2osdbk" 2014-07-25 18:01:26 +00:00
Gauvain Pocentek bb6df9a0a9 Provide openstack-dn2osdbk
This tool converts docutils native XML to docbook. The conversion is
done using XSLT, with some custom XML treatment.

The XSL source is a slightly modified version of Dn2dbk written by Éric
Bellot (http://ebellot.chez.com/dn2dbk/index.htm).

Modify doctest to check and build the HOT guide.

Implements: blueprint heat-templates

Change-Id: If866a5ffe19165c38981493684de550e0df0e36d
2014-07-23 15:12:36 +02:00
Jenkins 02a4c9aef5 Merge "Adds Python as a prerequisite to readme." 2014-07-21 17:53:49 +00:00
Pranav Salunke e1f0584979 Adds Python as a prerequisite to readme.
Adds python and python version to the prerequisite section.

Change-Id: If7a90f669a0326dae4f2924bfb65e0f98110bbc7
2014-07-21 19:36:52 +02:00
Andreas Jaeger 563f93b582 Update README.rst
Add some more information for 0.17.

Change-Id: Icb9ca84c5c158727980f3dfb72714be864367af4
2014-07-10 08:42:16 +02:00
Andreas Jaeger 43e797e21c Add 0.17 marker to README.rst
Change-Id: Ia27a68f94938aa1d7162de5a643b034cf9c5f4e6
2014-07-03 22:46:05 +02:00
Andreas Jaeger 4a4da3e263 Fix includes for rackbook.rng
For using as part of openstack-doc-tools the paths need to be adjusted.

Change-Id: I2844889bd47d5766b77401bacd2066ad272619dc
2014-07-02 08:45:36 +02:00
Andreas Jaeger fd7a735827 Update README.rst with recent changes
Update release notes for 0.16.

Change-Id: I8a5885022b66f17ddf113199b4a900f10581c748
2014-06-24 09:18:31 +02:00
Roger Luethi e11eaf8949 Update README
jsoncheck.py: add public API

Change-Id: Ie0b3894ab638c3620e5650cf77fdcfa33c2f7b48
2014-06-24 08:15:50 +02:00
Gauvain Pocentek bdb2f2f003 Provide a script to gerenate options changes
diff_branches.py generates a listing of the configuration options
changes that occured between 2 openstack releases.

This involves a few changes in other tools:
- the 'dump' subcommand for autohelp.py generates the serialized dict of
  options
- add a special case for the 'bindir' option to avoid getting different
  default values in different virtual environments
- the autohelp-wrapper -e switch builds the needed venv without
  running autohelp.py commands

Change-Id: I80da172b91b8d2f0a15f89f4c812864da2fea471
2014-06-10 22:50:46 +02:00
Andreas Jaeger c9b0d75ac7 Fix 0.16/0.15 notes
ignore-dir was not in 0.15 but entity-handing is in 0.16, I swapped
them.

Change-Id: I1248df5fb5870c208636accd717a30c46708c096
2014-05-27 21:59:31 +02:00
Andreas Jaeger 403fc23549 Fix README
The entitity change only went in for 0.16, move it in history.

Change-Id: Ibc35a5659e33acc0a83710725940b8595c65abcc
2014-05-27 17:42:26 +02:00
Andreas Jaeger b3874a2c60 Fix handling of ignored_dirs
https://review.openstack.org/#/c/94717/ triggered a bug in handling of
ignore_dirs: If a file in one of the ignored directories was changed, we
might still create dependencies for it and trigger an exception. Now we
remove also modified files in ignored directories.

Change-Id: I619d6c441a4fa4759e00d9c9e21c993707b19c6b
2014-05-27 00:00:19 +02:00
Andreas Jaeger 2af6041d17 Fix ENTITY bug with xml2po
xml2po breaks the entities, readd the %openstack if needed.
Note: If more entities are imported in translated files, we need to
rework this completely.

Change-Id: Ia1a955f2cfc5810db21d68d5f9cc4374a42cebd2
Closes-Bug: #1322224
2014-05-26 16:56:49 +02:00
Nicholas Chase 3cfe0a3fdf Remove Docbook conversion in tox for HA Guide
The High Availability Guide is currently written in ASCIIdoc, so
the tox scripts have to convert it to Docbook before continuing to
test. Remove all special casing needed for this.

Co-Authored-By: Andreas Jaeger <aj@suse.com>
Change-Id: I5a6c13e502d003237eb93d27028de2cb9db02e04
Implements: blueprint convert-ha-guide-to-docbook
2014-05-26 09:28:29 +02:00
Andreas Jaeger 5527d8d1a4 Add RETF to README.rst
Mention RETF in README.rst.

Change-Id: I7c0a1c33c21b07f18beba9b2fc0db46cf7b1d0c5
2014-05-26 09:13:51 +02:00
Andreas Jaeger cbcab05d2d Special case entity files
Build all manuals, if an entity file is changed, we cannot do include
checks right now if an entity file is changed.
Update list of special files to handle, remove obsolete test.py and add
top-level pom.xml

Change-Id: I2c139249bb97fbd43781fafefd9f72e3f663935e
2014-05-23 19:04:14 +02:00
Andreas Jaeger 0a5f6a54ca Show git info
Print information about the tested change.

Change-Id: I0f086cbc9e136cfa2245e4b546621f559c315ec8
2014-05-23 18:06:55 +02:00
Andreas Jaeger ec411ebf8e Fix for building identity-api
Patch https://review.openstack.org/#/c/94194/ changes the location
of the v3 API, handle the new directory.

Change-Id: Iadadec17d525acede71853c00ec4f075c75c0a05
2014-05-20 20:27:55 +02:00
Jenkins c545d83fce Merge "Fix generation of ha localized guide" 2014-05-13 15:38:05 +00:00
Andreas Jaeger 9622f376cb Fix generation of ha localized guide
The generatedocbook tool only works on XML files.
For the high-availability guide, we first need to generate the XML file
and then integrate translations - and take care that the build job not
regenerates the XML file.

Change-Id: Iab7a72d2819b4fc5d0bac53b8a9ccba2ba9ef0ef
2014-05-13 10:23:00 -04:00
Gauvain Pocentek ded3788ff3 autohelp.py: update the paramters handling
- generate the tables in the doc/common/tables dir by default
- make the -i switch optional, and assume that git git repositories are
  in a ./sources/ dir
- use elif's instead of multiple return statements in the subcommand
  test

Change-Id: If96ac9df247cea5061c056328307ec88ab74a4f3
2014-05-13 07:28:08 -04:00
Andreas Jaeger f9cfc13fda Display more information with -v
Display release path and comments enabled status with "-v".

Change-Id: I8c99e46a0fb9784a5c89c96c975395b9dc1008d4
2014-05-10 13:17:37 +02:00
Roger Luethi 3d61e98305 Add new script jsoncheck.py
Add a new script that can reformat JSON files and check for niceness.
We can use this later as niceness check for openstack-doc-test.

Change-Id: I33c5309bfa2e1abfa6a35d1cfcdc984775e85f05
2014-05-07 22:11:21 +02:00
Andreas Jaeger 930ddbac27 Warn about usage of non-breaking space
Non-breaking space is often not visible in our tools, or shown as normal
space. We should use &nbsp; instead. Warn about non-breaking space like
we warn about tabs.

Change-Id: I1bbbb1f19c56d3cc1b949df151b41886a0c46042
Related-Bug: #1314498
2014-05-01 09:58:45 +02:00
Andreas Jaeger b42cf18bab Place </screen> on proper line, fix swift usage
Change way on how the screens are generated so that we really
have </screen> on the closing line.

Also, update swift usage line so that it is not inside a screen but in a
normal para.

Add new option --output-directory for defining the directory where the
files will be written to.

Change-Id: Ie5d039ad673290720993586bd137c51183afa822
2014-04-29 19:29:52 +02:00
Andreas Jaeger 7f4c2f4720 Update README
0.14 is not released, merge changes back to 0.13 and cleanup a bit.

Change-Id: I619f975321d88011cd6af4e12ecf19bbe9ba0b8a
2014-04-26 09:21:46 +02:00
Gauvain Pocentek 8b6edc10fe extract_swift_flags: Improve the output
Since we need to edit the generated tables manually, a nicer
output will help a little. I hope...

Change-Id: I85222cb52d6f4ed2523729e7c31ddb7efaaab979
2014-04-25 23:21:10 +02:00
Gauvain Pocentek 5dcedd48d3 extract_swift_flags: fix the tables parsing
The code for parsing existing tables didn't find all the options because
of spaces and new lines. This patch should now handle those characters.

Change-Id: If6a5d8812e6e6f46e14944578cc5eb94d8374ccf
2014-04-25 23:07:50 +02:00
Andreas Jaeger 0a5f7e5c3b Handle translations for api-site
The generatedocbook command only handled books in subdirectories of
./doc. This assumption only works for operations-guide and
openstack-manuals but not for the api-site. Add parameter --root to give
the root directory. For the api-site, this would be "--root ./".

Change-Id: I9f477239677ca5a32b19bd565f8a37288f7e869e
2014-04-25 15:47:00 +02:00