We need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver [1] for the release team [2][3].
Removed specific doc requirements from test-requirements.txt.
The problem here is that this repos haven't doc/requirements.txt file
and by default in this case zuul will use the test-requirements.txt file
to
pull requirements [4].
This requirements file contains extra requirements like flake8 that
collided with those allowed in our job environment and so the new pip
resolver fails to install these requirements and the job exits in error.
This project meet the conditions leading to the bug.
/!\/!\/!\
Notice that I voluntarily added the doc directory even if no docs
are generated here because zuul will try to pull this requirements from
there first and the contained requirements are needed for reno but AFAIK
the releasenotes dir is ignored by zuul. c.f [4] for further details.
/!\/!\/!\
[1] http://lists.openstack.org/pipermail/release-job-failures/2021-January/001500.html
[2] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019611.html
[3] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019612.html
[4] https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-sphinx/tasks/main.yaml#L36
Change-Id: Ib224dfe036543c8ec7fe3074fe4280586d35de97
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
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
Remove obsolete section and comments, remove sitepackages usage,
thosewere only needed for the docbook XML code.
Change-Id: Ic9881dde14c4d8ac82f859134b2afc0ab88dc268
As part of migration to zuul v3, replace checkniceness by linters
tox target to use a more "common" target accross OpenStack.
Change-Id: I8a23d017902aee36fc1c415e166c7ba441a1fc34
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
Infra setup has been changed, remove now obsolote environments.
Also remove unused doc-tests.conf file, with current openstack-doc-tests
it is obsolete.
Change-Id: I35acc842db62ced0226dd2f27cf57f56a05d6409
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
Chinese (zh_CN) and Indonesian (id) have progress
enough to generate translated documentations.
Change-Id: Ie09b9999d82470f543db0257e631fe4234cac0ff
Partial-Bug: #1608992
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
Setup Korean API Quick Start for building and checking.
Note that it will not be published in docs.openstack.org,
as https://review.openstack.org/#/c/233348/ mentioned.
Change-Id: I03e8d2a1fd379094015748fc28196356462adf5a
We have a number of firstapp documents in a range of SDKs
that are in draft status.
Particularly, for SDKs like shade which have all four of the
conditional sections complete, we would like to issue a call
for testing, leading to their eventual publication.
Having an easily accessible link to give testers is a crucial
part of that process. This patch removes the lines that delete
the draft firstapp docs so they can be found on the draft site.
Change-Id: I0457babc095ab152512751b7cb453dc5c1957282
Cleanup directory so that the following commands work. This is needed
for developers invoking the publishlang-api manually.
Change-Id: I87379427305e0da06a9434479fa036368b7af463
Setup Japanese API Quick Start for building and checking.
Markup German not anymore as draft.
Do not publish content anymore on docs.openstack.org, our
jobs are going to use publishlang-api to publish on
developer.openstack.org instead.
Change-Id: I67d777a6c271fc8dc1ebe3e75b81a09e7c5c3efb
Prepare tox.ini for publishing to developer.o.o, this needs changes
in project-config to actually do the work.
Add comments to doc-tools-check-languages to point out special
treatment.
Change-Id: Ic467d8d53944b13e65555d910350547d3ded1a86
The check-syntax only looks at files itself but if an entity file is
changed that is included by other XML files, we would need to check those as
well. Since this is not done currently and there are many entity files,
let's always check all files for syntax problems.
Change-Id: I34970df274e12a15a485bcd8fc3930651af64d4e
Move imported files to common-rst directory so that we can share
translations with openstack-manuals.
Change-Id: I3f9be25579ae16550c32303117702d5500370b41
This patch adds support for pkgcloud to the First App tutorial
in section one.
The code has been tested on a cloud with nova-network.
Partial-Bug: 1449331
Change-Id: I50e5211b6f6df5c26fdcf6f2b39cc5a8308f787c
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
The Libcloud version of FirstApp is ready to move from draft stage
so it can be widely disseminated to satiate the burning need for this
content that is currently not being addressed. The guide was very well
received during it's packed-room summit sesion.
So far it has received significantly more editing and testing than
other sprint-created documents when they were published. This is thanks
to the work of: Andreas Jaegar, Karen Bradshaw, Diane Fleming, Shilla Saebi,
James Dempsey's users, Jon Proulx, Bruno Lago, Chuck Burkett, Dana Bauer,
and the original authors (at least 2 each section).
Any areas lacking in the guide are well understood and captured in the
bug list:
https://bugs.launchpad.net/openstack-manuals/+bugs?field.tag=firstapp
and there are no major blockers that would prevent listing this guide
on developer.openstack.org.
This patch links the libcloud section of developer.openstack.org to the
guide.
Change-Id: If85bc020cd54e3ca06e5d320024dec9428764641
For the RST guides, we do not need doc/source, since doc is always
empty. Use source directly.
This syncs the setup used here with openstack-manuals.
Rename top-level from openstack-firstapp to firstapp, there's no need
for the long name in this repo.
Change-Id: If4e11a4f90d580876865348e0d88b92cec4b6659
Add docs target that lists those firstapp targets that are currently
supported. Adjust .gitignore to ignore all build results.
Change firstapp commands so that we have separate build directories per
variant.
Change-Id: I7c5120b1af2de2c3df8f59fe29678e736368365f
Written during a book sprint in Taipei, from March 30th 2015
to April 3rd 2015.
Co-Authored-By: Sean M. Collins <sean@coreitpro.com>
Co-Authored-By: Tom Fifield <tom@openstack.org>
Co-Authored-By: James Dempsey <jamesd@catalyst.net.nz>
Co-Authored-By: Nick Chase <nchase@mirantis.com>
Co-Authored-By: Christian Berendt <berendt@b1-systems.de>
Implements blueprint openstack-firstapp
Change-Id: I55ae32d0c04f641c818bda4714d9bc691a98e6b1
Not all systems have a binary named "python2"
Related-Change: Ie498dca57cf262c8b3e61e210e2f89c6a7d5e0fb
Change-Id: If6602979e78d478363a6637390abf95badccfc86
Our documentation tools are not python3 compatible, so make sure that
tox creates python2 virtual environments during tests.
Change-Id: I5dca3a92773ffb499c7ba693e2b010cd8e19e8e2