Follow job rename in openstack-manuals, remove now unused
checkbuild environment and simplify build-index.sh script
since the same content is build everytime.
Also remove www/www-index.html, we do not use it anymore.
Depends-On: https://review.opendev.org/676956
Change-Id: I00b5afc14fc7872edc1c9db9a0aaa7949b1f1443
The document is now in openstack-manuals, we can remove it here
completely together with the jobs for building it.
Add a redirect to new location.
Depends-On: https://review.opendev.org/671115
Change-Id: Ife74ae2b83bdae1e206b0705faf6f623428a3f1f
These guides are dead, remove them completely. This will also remove
the documents from the developer website, so remove all links.
Change-Id: Ifd9a4d8a187962498d6f1133226a77308bc2f5ff
If jinja template parsing, rendering, or writing fails, we used to log
an error message and continue. With this change, we'll raise the
original exception so we print the traceback and fail the build right
away.
Change-Id: I9e92d3aed844d965a425c43c79a8844e5c4bd006
We track official service type names and their historical aliases. As
api-ref is organized by service-type, it stands to reason that if a
service-type changes (or has changed) that a link might exist to the old
value.
Use the service types authority data to generate a set of redirects for
all aliases of a service to the official service type location.
Change-Id: I96a5502ca6cd3e78f996ad9b60101c907e2150cd
With Zuul v2, the publishing happens from publish-docs/api-ref.
Let's simplify our scripts and publish with Zuul v3 from publish-docs
directly.
Add new jobs publishlang and publishbuild for Zuul v3 publishing.
Use existing publishlang-api and publishbuild-api for Zuul v2
publishing.
Remove now obsolete comment from doc-tools-check-languages.conf.
Change-Id: I32b29a34c571882cb4d7c542c543ea726e76a0b5
The last change had a typo in the job invocation, fix it.
Remove ls, the job output showed the content is available as expected.
Fix also permissions on shell script.
Change-Id: I4ef65188ccdeebf59cc684f2de99c2198c0c3127
Add marker files in the root of our tree.
This is needed for publishing in the future:
This is so that we can create a list of directories to ignore when we
rsync documentation builds to a publishing site. Some builds are
published as subdirectories underneath the results of superior
builds.
This allows those superior builds to be rsynced without removing the
other builds that were published under them.
Change-Id: I96a67f022f9fef0794a8a25b6e397177e30d1f5f
We do not need to build and publish the DocBook XML content anymore,
everything is frozen and in the process of moving to projects. Remove
set up for building of DocBook content.
This leaves the XML files still in tree, we can remove them later.
The DocBook XML gates are still setup, so some tox environments have
been made a noop.
Require openstack-doc-tools 1.0.0 which removes DocBook XML support.
Also, drop swagger building, this is not needed anymore.
Change-Id: I276953013a518a09dabb89bb8f80ef7739b4491b
- Move shade to the published documents in the build script.
- Add shade resources and documentation in developer.openstack.org
Change-Id: I85885b1bd3a8ec641c36dce0338ad237aa35da50
Also updates the tools/build-api-ref-swagger.sh script so that
the errant WADL file name is output.
Change-Id: I312c0be565983950a9fce0f6d653eacdcef2695c
Add getting_started tutorial for Gophercloud SDK, code had been tested
on a openstack cloud with neutron.
Change-Id: Ife8bc23671ddff175a5ff424e08893c746d97482
Added tools/build-index.sh which will build an index.html and copy
needed static files into publish-docs/www
Change-Id: If65a9da675a182f0aab659cb076c3a4aba032b58
Added a scaling out code sample for jclouds and modified the
scaling out chapter to reference it.
Also modified the build so that the jclouds draft documentation
is now generated so that we can see the code appear in context.
Change-Id: Iaf9ee952e008bdb68e52717524de723597da0690
Partial-Bug: #1449330
To publish the draft guides, we need to move them to publish-docs/api-ref.
Fix the publishing location.
Change-Id: Iaf27e9315031be232672ae4d33efff2c0db9ce65
The guide has no common directory, therefore we have no common
translation. Handle this in our script.
Change-Id: Id34b92430ef4da804335714710547ada02c23cef
Use the same shell scripts like openstack-manuals for building of RST
files. This simplifies the tox.ini file and allows easier adding of new
tags.
This now build dotnet, fog, and pkgcloud versions as draft documents and
continues to publish the libcloud version.
Change-Id: Id5deebbb54904a44691104e19ef60f15a14c0f7c
After https://review.openstack.org/#/c/144685 merges,
the automatically generated configuration reference
tables will be marked up as
<option>option_name</option> = <replaceable>default_value</replaceable>
As none of this should be translated (option_name is the same
regardless of language), this patch updates generatepot to ignore
option_name s tagged with <option> for translation.
This should significantly reduce the number of strings required for
translation from the common directory in particular, where
many of the 8000-odd strings do not actually need translation.
Change-Id: Ib859cc9a77dc05aad1317a67962aae516f6a4f0b
We have git to track the authorship of files. It is not necessary to use
the @author tags in the copyright statements.
Change-Id: Ibd967ed83022cab4a0f8c5b7135934138bdba0d6
Fix help text of test-languages.sh.
Use "test" instead of publish for buildlang invocation which can
be used to manually build translated manuals.
Change-Id: I617e8008e78bebc2d4e6c09300606a50d4b37ebc
Rework test-languages so that we can test *all* languages as well
if needed and use the same script for both buildlang and testlang.
Add new tox job "publishlang" to publish all languages at once.
Change-Id: I7c7a5622df219f8ffa2dd1b824179de749ea2fed
This is the initial setup to build translated manuals. For now only the
api-quick-start is build.
This needs openstack-doc-tools version 0.13.
Change-Id: I140b8007d76bda5f436cbd80e77b890852c71827
Andreas Jaeger