Commit Graph

38 Commits

Author SHA1 Message Date
Adam Spiers 4a53589fea www-generator.py: cache expensive repo/project metadata to disk
Gathering the metadata of repos and projects requires a significant
number of HTTP calls and is therefore slow and expensive.  When
hacking on www-generator.py the ability to skip these calls can save a
lot of time allowing much more rapid iteration.  So add a persistent
cache for this data, using the percache Python module.

This is mostly run in the gate, where the cache will be deleted on
each run.  Documentation contributors running this locally may
occasionally need to manually remove the cache file, although
governance data generally changes slow enough that this is expected to
be a rare corner case.

As noted by the comment in _get_official_repos(), in the future we may
add support for loading governance data from a local repo, thereby
skipping the need for slow HTTP calls.  But for now this is a simpler
solution.

Change-Id: Ib52171625e37169d00da03f436b58456c103b04d
2019-01-04 17:10:22 +00:00
Andreas Jaeger ac26723259 Cleanup .gitignore
Remove now obsolete content.

Change-Id: Ie14f87f23b4f6cf494a22040eb1d5f00dbd3cc5a
2017-07-21 20:26:29 +02:00
qiaomin 48bb37d6ef Add "*.swo" to ".gitignore" file
Change-Id: Ia94bbf64f955f3da453df8903a23be32ba9be8de
2016-08-09 06:18:46 +00:00
KATO Tomoyuki 31b31410f9 Factor out Install Guide for Debian with debconf
To simplify the build tool chain,
factor out Install Guide for Debian with debconf.
Continueously, keep Install Guide for Debian without debconf
in the doc/install-guide directory. Also, use the contents
at doc/install-guide as possible for consistency.

On the following patches, clean up doc/install-guide sources
to cleanup the contents and build tool chains.

Change-Id: I8df6b3b382137d08d60f85bc41bcd98ac1f4eb47
2016-05-19 17:37:53 +09:00
Andreas Jaeger ed100316b4 Convert glossary to RST
We do not need the DocBook XML glossary anymore, since we do not build
any DocBook guides that use it.

Add instead the RST version of the document to git.
Adjust scripts to not build or publish the glossary anymore.

Change-Id: Id4bfef7666690e6d08291f664751db7a4d4d5983
2016-05-02 09:20:30 +02:00
venkatamahesh 8f87fb477a Delete unnecessary /generated/ from .gitignore
Previously "/generated/" is the folder in cli-reference. At present
as cli-reference is migrated to rst and no more using folder "/generated"
So we can remove this from .gitignore

Change-Id: I9b5bad398a4842abac4e94a6c8a87df3b4df0637
2016-01-18 18:45:22 +05:30
Andreas Jaeger cbeb4d5c5b Revert "Add reno for release-notes"
As discussed via email, let's do this on a smaller scale.

This reverts commit 9432a6da0c.

Change-Id: I27e9cd06c5d69917abe452e873873683e10c282a
2015-11-10 14:49:13 +00:00
Andreas Jaeger 9432a6da0c Add reno for release-notes
Add renote to automatically generate release notes - the same way other
OpenStack projects do it.
For details see
http://lists.openstack.org/pipermail/openstack-dev/2015-November/078301.html

Change-Id: Iac8f34ae3490b7788c989b17be3e6a616e65c676
2015-11-07 17:34:29 +01: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
Brian Moss faead21540 Add build-debian to .gitignore
Adds the /doc/install-guide-rst/build-debian/
build directory to .gitignore

Change-Id: Iaea99de92f33cd7423694c16c90d2fe01d4369b0
2015-07-27 14:24:12 +10:00
Andreas Jaeger 52bbdc220f [install-guide-rst] Set up conditionals for distros
Add support for conditionals for the Install Guide.

This uses the tags:
* rdo
* obs
* ubuntu

Note that this is changed from the spec since sphinx does not accept a
"-". Also, I changed from opensuse to suse for brevity.

Adds new tox target so that "tox -e install-guides" builds only the
RST Install Guide.

implements bp installguide-liberty

Change-Id: Ibdfbc7ff294e56f52cd6f4ef59ceeb7b6af3e28a
2015-06-17 20:37:05 +02:00
Andreas Jaeger b84857108c Build translated RST manuals
Build translated RST manuals. This needs openstack-doc-tools 0.26
release, thus bumped up requirements.

Import also Japanese User Guides translations so that this can be
tested. We only create an empty file for it, this will trigger the
import and enable us testing of the toolchain.

Ignore some build results.

Change-Id: Ic51974445730cbfa886beb7cfd4fcf71977dab3c
2015-05-07 08:06:14 +02:00
Andreas Jaeger a8224a68b5 Add RST Glossary
Automatically convert the glossary from DocBook XML to RST with each
build and use it for building the RST guides.

Add the glossary to User Guides and Networking Guide.

Use glossary in User Guides in places where it was used before. This
removes one TODO.

Fix CORS capitalization.

Partial-Bug: #1421813
Change-Id: I3fba6d54b01759f39f8e1467a7606cdbd2dd0165
2015-04-14 19:57:35 +00:00
Andreas Jaeger 5db746f9e8 User Guides: Rename playground-user-guide to user-guides
Move files to final place.

Change-Id: I3e88ce145f05daafb23c0516cd9da75a92b62e3c
2015-04-03 19:19:10 +02:00
Anne Gentle 07540b4cf0 Adds Admin User Guide build to tox file
- Uses -t admin_only tag for building the admin version of the user guide.
- Add files to cli.rst that were not included anywhere.
- Add flag -E to sphinx-build to ignore old content which might lead to
  strange local build bugs.
- Add build-admin directory to .gitignore.
- Fix scope.py extension to properly remove files from toctree.


Co-Authored-By: Andreas Jaeger <aj@suse.de>
Change-Id: Ide51cf83c148060d3064ebcb9535b3d3a29c83cf
2015-03-24 20:11:24 +00:00
Andreas Jaeger 1b74d7ca0d Fix RST translation
Fix generatepot-rst.sh script to not generate duplicate messages and
properly delete generated files.

Let git ignore any python compiled files.

Change-Id: Ib0cb58980ba2bc751cfed9ad56942aedfb62d07e
2015-03-13 09:16:02 +01:00
Christian Berendt 40b657f993 Use a static site generator to generate content in www
Change-Id: I2f0c61006ef8885e157eb2b800080407f2bae393
2014-08-14 10:02:26 +02:00
Gauvain Pocentek cb4075048f Includes a basic HOT template guide
The 2 RST files are copied from the heat developer documentation without
any change and are just a starting point.

This patch requires this change in the openstack-doc-tools:
https://review.openstack.org/#/c/108034/

Change-Id: I03511655c86ead880cadfa68b43bb2b90d3f7c06
Implements: blueprint heat-templates
2014-07-28 21:48:55 +02:00
Andreas Jaeger b0350b7734 Move cli generated files out of common
There's no shared usage for these files, so move them into a
subdirectory of cli-reference.

Call the subdirectory generated and add a README so that it's clear that
these are generated files.

Fix also .gitignore to only ignore some top-level directories.

Change-Id: Ifb455a8640cc7e735ed81563b438d68522e73ded
2014-07-20 20:30:30 +02:00
Nicholas Chase 0d21ce440d Convert HA Guide to XML
This patch does the initial conversion of the High Availability
Guide to XML from ASCIIdoc.  No changes to the structure have
been made; this is simply the XML that gets generated by asciidoc.

This patch includes the following changes to the original HA
Guide:

- Content now appears in a single Docbook XML file, to be
  broken out in the next patch
- Original ASCIIDoc files have been removed
- pom.xml has been updated to reflect the new source
- .gitignore has been updated so that it no longer ignores
  bk-ha-guide.xml

This patch is simply to establish the new structure.  To prevent
front-end disruptions it includes all of the existing content,
but the content hasn't been audited or broken out into individual
files.  For ease of review, that will be done in the next
patch(es).

(This patch also includes the corrections and changes that were
originally part of https://review.openstack.org/#/c/93856/2,
corrected so that list appears properly.)

Implements: blueprint convert-ha-guide-to-docbook

Change-Id: I0455716c037b5e6e698bfca72162aba29f339e8a
2014-05-27 19:38:23 +02:00
Martin Lopes 614e0b2f06 Edits and shuffles FWaaS content
Adds new FWaaS section to networking intro section. Adds overview
diagram. Includes operational FWaaS content moved from Advanced API
section.

Change-Id: I5b0a9182c25d624598d37172918ad8cd01d5f880
Closes-Bug: 1304745
2014-04-14 12:41:17 -05:00
Sascha Peilicke 69219536f6 Re-add .tx/config
This reverts commit 81a8a03. While .tx can certainly be generated by
infra jobs on the fly, this helps people that want to work on
translations with (local) tools instead of Transifex web-interface.

Change-Id: I77ed05e929cc7500ab4ab9a46e96eb6e1384e7a7
2014-03-20 15:18:14 +01:00
daisy-ycguo 81a8a03535 Remove folder .tx from git tree
Folder .tx is used to save the configuration of Transifex Client.
Tracking .tx by git will cause an error while running the script:
propose_translation_update_manuals.sh
Folder .tx could be created on the fly.
So this patch removed folder .tx from git tree.

Change-Id: I582a11efc330abd3d263e1563d1ebed3fd42f974
2014-03-12 14:36:33 +08:00
Andreas Jaeger 0621858e3e doc-tools: Ignore build-*.log.gz
Change-Id: Id7a6f1e16bf1979274caba27fabe1c39590f3ca4
2014-02-08 22:12:23 +01:00
Andreas Jaeger ad92297e4b Create tox jobs for translated manual
Create new job for building of translated manual.
The job needs version 0.5 of openstack-doc-tools to support the "-l"
flag.

Change-Id: Ic898d364650a6f3e2aac2fa13af779627bd53883
2014-02-04 21:31:37 +01:00
Andreas Jaeger 64f06adfba Ignore publish-docs directory
Ignore publish-docs directory. This is the directory used by
openstack-doc-test to copy draft documents to.

blueprint draft-docs-on-docs-draft

Change-Id: I4267e02e540b4283b273092d8566894a2c422444
2014-02-02 15:18:52 +01:00
Andreas Jaeger a6ff7c625c Cleanup gitignore a bit
Remove unneeded gitignore files
Cleanup normal gitignore file a bit:
* Add Build results comment
* add slash to .tox to mark it as directory

Change-Id: I9a82a6353e3b8cec186e8b688489916d9355f0da
2014-01-09 22:33:57 +01:00
Andreas Jaeger a9f98d343d Setup for openstack-doc-tools
Add files to allow gating via:
tox -e checkbuild
tox -e checkniceness
etc

Also, enhance .gitignore to ignore files used by gating
via openstack-doc-tools

Change-Id: I96b669e14425265a033a549264c2158e2b1afa3e
2013-12-31 17:38:46 +01:00
Pranav Salunke 515aaee3f3 Modified GitIgnore File for Vagrant
Added a few entries to ignore vagrant related files. These files
can tend to be heavy and are not required to be the part of the
source.
Removed Vagrant from the .gitignore. Thanks Trevor

bp/training-manuals

Change-Id: Icb89d49566367adcd4db5fe412914d852c22830b
2013-10-19 22:18:33 +05:30
Andreas Jaeger 40a73e6db8 Build all Install Guides and HA Guide in gates
Build books the same way we build them for publishing:

Build all three variants of the Install Guides if we check building.
Since we introduce os specific sections, the guide might build for one
variant but not the others.

In case of failure, the variant is shown like:
Building all queued 1 books now...
>>> Build of book install-guide (for Ubuntu) failed (returncode = 1).

Also, generate the xml file for the HA guide and build it.

Add generated file bk-ha-guide.xml to .gitignore

Add parameter -B for building to mvn to silence download progress

Run test.py and validate.py through pep8 and fix any issues

Change-Id: Icfb4587e7c08050d1b65dddc5a3a810a8bf12f5a
2013-10-01 08:58:02 +02:00
Andreas Jaeger 96b72db1a8 Ignore emacs backup files
This ignores emacs backup files like image-guide/pom.xml.~1~ or
image-guide/pom.xml~

Change-Id: Iefae6a1dd3a69212db38e07c925019efae57a747
2013-09-10 22:54:26 +02:00
Victor Rodionov 7c288dc20c Update Nexenta driver doc
Replace Nova with Cinder

Change-Id: Ibb125dab9c676e84e52f628679bf178e5c9f2266
2013-09-05 01:28:56 +04:00
Dolph Mathews e073803fd5 Ignore vim swap files
Change-Id: Ie77a477d72e60398bc387ada6cb9a2017a07cc0b
2012-10-02 23:21:27 +00:00
annegentle 916c3383b7 Fix doc bugs -
bug 1034021 trailing off sentence in overview
bug 1034772 included typo
bug 1034462 scheduler typo
bug 1017691 change in name of root wrap config option

Change-Id: Ia7ecf12f39771c49915b927ea3f0de89c9f28327
2012-08-17 15:38:28 -05:00
Jesse Andrews b6a28b0093 standardize capitalization: ReST -> REST
source: http://en.wikipedia.org/wiki/Representational_state_transfer

Change-Id: If35339d1dc663c5b07a23bf62cb551bb29fe8037
2012-02-29 23:18:48 -08:00
Lorin Hochstein 7e9de9b325 Added info on how to build docs to the README.
Added info in the README.rst about how to generate the documentation.

Word-wrapped all text to 78 chars or less.

Now ignores Oxygen XML editor project files (.xpr)

Change-Id: I167605c95c706ac1ef82393aa8301594ced1e01d
2011-11-28 09:03:11 -05:00
Lorin Hochstein a184a65e06 Removed and ignored auto-generated files.
Remoed all files in target/ subdirectories.

Fixed .gitignore so it properly ignores these files.

Change-Id: Ib435a9cc3d858081717d838e48528a96239e2e9d
2011-11-20 19:24:33 -05:00
annegentle acca546883 Adds keystone pom.xml file
Change-Id: I5f74951c915c41ed4fe0f7498b7f463e1cc4242a
2011-09-28 13:13:00 -05:00