Commit Graph

59 Commits

Author SHA1 Message Date
Andreas Jaeger b914be59ca Fix URLs
Change docs.o.o/developer/ to new location.

Change-Id: I99bed6eccdf462bac6d8ac3f7b034a457a8bbdbc
2017-09-07 19:55:58 +02:00
Andreas Jaeger 0e526705c6 Update RELEASE_NOTES
Add link to current release notes, use https and fix a layout problem.

Add two new subsections so that not all releases show up in the table of
content and clutter it.

Change-Id: I56444568a671b2bf6c052bc2a17f129c5dcf43e3
2017-05-01 10:13:41 +02:00
Anh Tran e301382594 Typo fix: occured => occurred
Change-Id: I6876d064d93b3a4023326303904f9205e24149d3
2017-01-23 13:11:50 +07:00
zhouyunfeng 3fdbbc3613 Typo mistake
Change-Id: I589851163c891bbace474c5f66efc9d298a9e62a
2016-11-15 10:20:22 +08:00
Andreas Jaeger 3f96fbeca3 Update RELEASE Notes
Mark RELEASE_NOTES.rst as obsolete and give pointer for new work flow.
Move one entry from current RELEASE_NOTES to reno.

Change-Id: I94d81e00d0a4405c1dfce9fdb83a2ec6f26eae5a
2015-11-15 09:56:56 +01:00
Gauvain Pocentek ec0626ab74 Update autohelp-wrapper to support RST output
Change-Id: If5829f7651a56f1651f4becc5af0744609d75310
2015-10-30 18:45:44 +09:00
Christian Berendt b8161e3aff Removed a virtual build and test environment based on Vagrant.
The virtual build and test environment based on Vagrant is out of date.

Change-Id: I8c855f9a92894d1c160a2bc8461a2883eb4950a9
2015-10-30 04:11:57 +01:00
Andreas Jaeger 517f88d480 Update Release notes for 0.31.0
Add major new themes to file.

Change-Id: Ie8b884049030ad572de6b8297f2f4a5f11c66289
2015-10-06 18:45:18 +02:00
Andreas Jaeger 2de03ff6ce Add doc-tools-build-rst
Import tools/build-rst.sh from openstack-manuals to share it between all
repositories.

Change-Id: I3fd807f08a23e706a3edc70314ab276c363a43e9
2015-08-26 11:03:30 +02:00
Andreas Jaeger bd539fc715 Fix Install Guide builds
Fix building of Debian RST Install Guide, it has a different index file
that needs to be renamed.

Cleanup after builds and remove temporary produced files and changes to
checked-in po and pot files.

Update RELEASE_NOTES, include entry for another change.

Change-Id: I1de8a70d7d4b483e023411b8949f77b093b72b11
2015-08-26 09:41:11 +02:00
Andreas Jaeger eb5f3ef18f Handle translation of Install Guide and FirstApp
These documents have several variations and we need to build all of
them.

Fix handling of draft documents for these.
Silence sphinx and msgmerge.

Change-Id: Ia34dab84f51838171240f8a0b17dec5f65058fc5
2015-08-24 15:43:21 +02:00
Gauvain Pocentek 2e63aba8ac autohelp: support reading options from multiple repos
This change modifies the -i option behavior of autohelp.py to add the
possibility to find configuration options in multiple repositories. The
change implies a few related modifications:

- do not check if the source repository is a git repository
- update autohelp-wrapper to clone and use the additional repositories
  (only for neutron at the moment)

Note: diff_branches.py will not work with this change, it'll be fixed in
another patch.

Closes-Bug: #1448107
Change-Id: I4999aca4f7926e19513acdf38f1e2828b52cee13
2015-07-23 16:49:43 +02:00
Gauvain Pocentek a92753f4cb Remove the heat-ref related tools
Since the hot-ref and hot-guide are going back to the heat repository,
some tools are not needed anymore:
- dn2osdbk
- the hotref sphinx extension

Change-Id: I9f8539f73b4dedc5236f8ff5d5b03c93c602c661
Depends-On: Ie2240d2fca5d6e43b1d186645e7ff9107514f289
2015-07-22 20:10:08 +00:00
Andreas Jaeger 5e9b716092 Always build index for checkbuild
Always build the index files during checkbuild. With RST guides, the
index was not build everytime.

Also, update the Release Notes.

Change-Id: I2b7f2e02e81de8255307d5a0b1b3f10f73c13273
2015-06-26 10:50:22 +02:00
KATO Tomoyuki f7895df40e Add --use-first option to msgcat
When msgcat command merge common-rst po files,
it uses only first msgstr so that Sphinx handles
properly the po file.

Change-Id: I0e744646bfe1fd398cffda316872128d563c893a
2015-06-21 18:00:16 +02:00
Andreas Jaeger 6fa66c8344 Update RELEASE_NOTES.rst
Prepare for 0.29.0 release with adding recent changes.

Change-Id: I366553f8b4dcac253ebc868d9566668760e86636
2015-06-19 07:56:45 +02:00
Andreas Jaeger 6a846ecfe8 Handle common-rst pot file
Merge in content from separate common-rst pot file for translations.

Change-Id: I2b530ea7dad5dc77a72ed8d4bfcf52fa7aef6c46
Co-Authored-By: KATO Tomoyuki <kato.tomoyuki@jp.fujitsu.com>
2015-06-17 16:47:08 +02:00
Andreas Jaeger 552c693585 Fix RST languages
Add handling of user-guide and user-guide-admin, fix wrong path for all
RST files.

Change-Id: Ic71711dc8f2acd3a4f8d127d1ff9de5e6d279acd
2015-05-12 09:24:54 +02:00
Gauvain Pocentek fc33f23051 diff_branches: improve handling of deprecated options
Add options containing DEPRECATED in their help strings to the deprecation list.

Change-Id: Ie61b71754b02c8d97019aea71f0b1e1d4862e95e
Partial-Bug: #1433367
2015-05-09 21:53:51 +02:00
Andreas Jaeger dec4db24b4 Sort entries in index.html
Sort the entries in index.html generated by openstack-doc-test for
previewing changes.

Change-Id: Ia47351f7f0b067ce8dd97798eeb0063aaccbdf23
2015-05-08 20:19:58 +02:00
Andreas Jaeger 4282827471 openstack-doc-test: Fix index.html
Remove www pages from index, we have the index file for it.

Change-Id: Ic06c5708f888a3ab7fb678f845d36dd599461dd1
2015-05-08 10:24:04 +02:00
Andreas Jaeger 4eadc65172 Do no build Debian Install Guide by default
Disable building of the Guide by default, add a switch to enable it.
We're not publishing the Guide in current releases at all, so no
need to build it.

Change-Id: I31f235bce2e65b5de4ca2528c85c8c06d8550626
2015-05-06 20:45:42 +02:00
Christian Berendt fcfe1f6af3 Further improvements for openstack-auto-commands
* new command for trove-manage
* automatically identify deprecated subcommands
* move client definitions into a YAML resource file
* support of the complete subcommand
* add new clients: barbican, designate, manila, magnetodb,
  manila, mistral, tuskar

Clients to be added in the future:

  * congress (module for python-openstackclient)
  * magnum (no released version)
  * murano (missing --version parameter)
  * zaqar (module for python-openstackclient)

Change-Id: I5ccb5af887749ec22a9d980e3b031de6a247041e
2015-05-04 16:50:24 +02:00
Christian Berendt 1e32726db2 Improve openstack-auto-commands
* add support for bash-completion for python-glanceclient
* add missing commands for python-swiftclient

Change-Id: I495ab17e0acbf0f33c3d306ec0a5bdf0d5d41560
2015-04-30 23:01:45 +02:00
Andreas Jaeger 779f474a53 Fix translation building and publishing
The translated RST guides were not moved to the publish directories,
move them over for publishing.

Also fix draft publishing for guides that use /draft like install-guide
and config-reference.

Change-Id: Ia80ffc2ab1825d4c1a6b16eef0df39ae28e0c77c
2015-04-30 12:39:38 +02:00
Gauvain Pocentek b2b72bd32b autohelp: add a neutron hook
Import and call some plugins methods to bring back their options.

Change-Id: Ie1ef9556b2b54a2f3b6dfe251a430ae8438233bc
2015-04-24 16:00:59 +02:00
Gauvain Pocentek b34cbe08e9 Update RELEASE_NOTES.rst for the 0.25 release
Change-Id: If7fa35fe52a1086fa71b69d9f8668bf8ebfb90fc
2015-04-24 12:19:00 +02:00
Andreas Jaeger 8509b5cb95 Handle RST languages and drafts
Enhance doc-tools-check-languages to handle translation of RST languages
and publishing of draft languages to /draft/

Partially implements bp draft-publishing

Change-Id: I7fd78228cfaa6e878ebdbf1432514ca453deec30
2015-04-23 07:20:29 +02:00
Andreas Jaeger 66843e2440 Update RELEASE Notes for 0.24 release
Change-Id: I8661d8ff29f65a1ef4fc5bf66a66f060f4800213
2015-04-09 20:14:37 +02:00
Andreas Jaeger 3f4165265a Handle User Guides
Handle guides that have no content subdirectory for creation of the
preview index.html file. Examples are the User Guides.

Change-Id: I4c647ee997a4776011db2677d2a84237989f0a06
2015-04-03 21:27:47 +02:00
Christian Berendt 562179013d Add wrapper script to update CLI references
doc-tools-update-cli-reference is a wrapper script to update
CLI references in the openstack-manuals repository.

Change-Id: I27f81d783db70206e4fdd1110da354bc9df90b70
2015-03-12 15:53:20 +01:00
Andreas Jaeger fbef0ea1c1 Handle RST files
Do not build all manuals if only RST files are changed.

Change-Id: Ie0790d7bebd676c9430a4295fe4421cbd74cbd8c
2015-02-23 14:14:52 +01:00
Andreas Jaeger ec79ad5672 Add option --ignore-book
This allows for example to properly ignore the Install Guides from getting
build and published.

Change-Id: Id957ec3cdfc2f67f039bbca76950dd4a1d8c34a6
Partial-Bug: #1423302
2015-02-18 20:17:17 +01:00
Christian Berendt 113bdc4b26 Adds niceness check to avoid unwanted unicode charaters
This check helps to avoid the usage of unicode characters like
“...” or ‘...’.

Change-Id: I53e999fc91336871e1c32c70745f7d7cf2e256cf
2015-01-09 08:30:12 +01:00
Roger Luethi e77e51365b Add final newline to file formatting
The JSON formatting created by jsoncheck.py omits the file's final
newline. It claims that files with such a newline need reformatting
and removes the final newline in a file when reformatting.

This patch brings jsoncheck.py in line with the rest of the tools
which prefer text files to end with a newline.

Update release notes for pushing out the bug fix.

Closes-Bug: #1403159
Change-Id: I35eab544b183c05b167ce9917d92f0f1f919b745
2014-12-16 22:02:24 +01:00
Andreas Jaeger e01d46abd0 Update RELEASE_NOTES
Update with changes since 0.20 to prepare for a 0.21 release.

Change-Id: Iaf03108bb3e91eb3431dd660afb22d31c2498613
2014-12-15 10:19:20 +01:00
Gauvain Pocentek f24863cf4d dn2osdbk: handle internal references
The internal references were not properly created. This patches make the
:ref: inline markup create a <xref> tag when the reference is internal.

This patch also reworks the sphinx extension to handle the URLs that
will be generated in the hot-reference with the new :ref: behavior.

Closes-Bug: #1378073
Change-Id: I84bf268dc1055dc6b39f23c4415734184ec57eec
2014-10-11 07:58:38 +02:00
Christian Berendt 45cf0461e4 Ensure a newline (\n) at the end of a file
Change-Id: I1ab532b4c3d7410d3f0826f1ba678d2933780b52
2014-10-01 07:21:13 +02:00
Andreas Jaeger 20139677b3 Document cinderclient v2 as well
Document cinder v2 commands as well.

Partial-Bug: #1369149
Change-Id: I9ba1c4d47dcb71bfb003779c5bc765ba6348d9c8
2014-09-13 21:53:42 +02:00
Andreas Jaeger a2824e109c Document glance v2 commands
The glance v2 commands need to be called as:
glance -os-image-api-version 2 CMD

Implement logic for this and enhance output.
Closes-Bug: #1367430

Change-Id: Ibc81d49494a203c9c8f469a2a0f93e4c1786af7e
2014-09-10 22:17:26 +02:00
Andreas Jaeger d2d93f7273 Document openstack client
Handle openstack client command.

Change-Id: I1c55eaf7619d07c0bc07e6ef3328bb10c24e9079
2014-09-06 18:25:40 +02:00
Jenkins 9f4a033586 Merge "Provide the hotref sphinx extension" 2014-09-06 16:15:33 +00:00
Gauvain Pocentek 5324dfe7de Provide the hotref sphinx extension
This extension simplifies the generation of hyperlinks referencing HOT
resources in the hot-reference book. It will be used in the hot-guide.

Change-Id: I382b5960733bec9b96924475887b02c8b1b01ea6
Implements: blueprint heat-templates
2014-09-06 14:11:44 +02:00
Gauvain Pocentek b4cb74cb07 autohelp: add a module blacklisting mechanism
Change-Id: I932bc5ad740c9eaee3d1db05462ccb2c2a2779a7
2014-09-06 08:44:39 +02:00
Andreas Jaeger b612a6d598 Add fast option to autohelp-wrapper
Add -f option that uses existing environment and sources for quick
turn around.

Change-Id: I4f7febfb95701316387c640c676fb2da24063303
2014-08-28 15:52:42 +02:00
Jenkins b7cb32e44c Merge "autohelp-wrapper: support the create subcommand" 2014-08-26 06:05:05 +00:00
Gauvain Pocentek 1e6eab3eab autohelp-wrapper: support the create subcommand
This subcommand generates an initial flagmappings file.

Change-Id: Ic1b3b8605ebdbbb3bd5d1852174c9d2f260b6c93
2014-08-26 07:35:31 +02:00
Andreas Jaeger 13019d8274 autohelp: Set table names
Use PROJECT.headers file to map categories to table names.

Change-Id: Iec437160c40f0c51f731e40e043bfbd163c0c83c
Closes-Bug: #1361026
2014-08-26 06:32:20 +02:00
Gauvain Pocentek d0e1a97df9 Improve the autohelp scripts
wrapper:
- Don't modify the openstack-manuals repo if it exists, keep it as is
  git wise (no branch change, no pull)
- Install oslo.i18n and hplefthandclient
- First setup the environment, then do the update/docbook work

autohelp.py:
- Handle projects not using oslo.i18n (mostly for havana)

diff_branches.py:
- Update the output format
- Setup the venv for the requested projects only

Change-Id: I48c45a56f4b7b7298fef0b7595d62e445c92df39
2014-08-23 09:11:17 +02:00
Andreas Jaeger 58e92c0ce6 Handle translations, update RELEASE NOTES
Ignore patches that only update the po files unless translations should
be built.

Update release information for 0.19.

Change-Id: I587688d207d244e72e1fc035d4fe5d72a1b5da88
2014-08-22 06:44:14 +02:00